amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.Lens

Contents

Description

 
Synopsis

Operations

AddAssociation

addAssociation_associationType :: Lens' AddAssociation (Maybe AssociationEdgeType) Source #

The type of association. The following are suggested uses for each type. Amazon SageMaker places no restrictions on their use.

  • ContributedTo - The source contributed to the destination or had a part in enabling the destination. For example, the training data contributed to the training job.
  • AssociatedWith - The source is connected to the destination. For example, an approval workflow is associated with a model deployment.
  • DerivedFrom - The destination is a modification of the source. For example, a digest output of a channel input for a processing job is derived from the original inputs.
  • Produced - The source generated the destination. For example, a training job produced a model artifact.

addAssociation_sourceArn :: Lens' AddAssociation Text Source #

The ARN of the source.

addAssociation_destinationArn :: Lens' AddAssociation Text Source #

The Amazon Resource Name (ARN) of the destination.

addAssociationResponse_destinationArn :: Lens' AddAssociationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the destination.

addAssociationResponse_sourceArn :: Lens' AddAssociationResponse (Maybe Text) Source #

The ARN of the source.

addAssociationResponse_httpStatus :: Lens' AddAssociationResponse Int Source #

The response's http status code.

AddTags

addTags_resourceArn :: Lens' AddTags Text Source #

The Amazon Resource Name (ARN) of the resource that you want to tag.

addTags_tags :: Lens' AddTags [Tag] Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

addTagsResponse_tags :: Lens' AddTagsResponse (Maybe [Tag]) Source #

A list of tags associated with the SageMaker resource.

addTagsResponse_httpStatus :: Lens' AddTagsResponse Int Source #

The response's http status code.

AssociateTrialComponent

associateTrialComponent_trialComponentName :: Lens' AssociateTrialComponent Text Source #

The name of the component to associated with the trial.

associateTrialComponent_trialName :: Lens' AssociateTrialComponent Text Source #

The name of the trial to associate with.

associateTrialComponentResponse_trialArn :: Lens' AssociateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

associateTrialComponentResponse_trialComponentArn :: Lens' AssociateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

associateTrialComponentResponse_httpStatus :: Lens' AssociateTrialComponentResponse Int Source #

The response's http status code.

BatchDescribeModelPackage

batchDescribeModelPackage_modelPackageArnList :: Lens' BatchDescribeModelPackage (NonEmpty Text) Source #

The list of Amazon Resource Name (ARN) of the model package groups.

batchDescribeModelPackageResponse_batchDescribeModelPackageErrorMap :: Lens' BatchDescribeModelPackageResponse (Maybe (HashMap Text BatchDescribeModelPackageError)) Source #

A map of the resource and BatchDescribeModelPackageError objects reporting the error associated with describing the model package.

batchDescribeModelPackageResponse_modelPackageSummaries :: Lens' BatchDescribeModelPackageResponse (Maybe (HashMap Text BatchDescribeModelPackageSummary)) Source #

The summaries for the model package versions

batchDescribeModelPackageResponse_httpStatus :: Lens' BatchDescribeModelPackageResponse Int Source #

The response's http status code.

CreateAction

createAction_description :: Lens' CreateAction (Maybe Text) Source #

The description of the action.

createAction_metadataProperties :: Lens' CreateAction (Maybe MetadataProperties) Source #

Undocumented member.

createAction_properties :: Lens' CreateAction (Maybe (HashMap Text Text)) Source #

A list of properties to add to the action.

createAction_status :: Lens' CreateAction (Maybe ActionStatus) Source #

The status of the action.

createAction_tags :: Lens' CreateAction (Maybe [Tag]) Source #

A list of tags to apply to the action.

createAction_actionName :: Lens' CreateAction Text Source #

The name of the action. Must be unique to your account in an Amazon Web Services Region.

createAction_source :: Lens' CreateAction ActionSource Source #

The source type, ID, and URI.

createAction_actionType :: Lens' CreateAction Text Source #

The action type.

createActionResponse_actionArn :: Lens' CreateActionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the action.

createActionResponse_httpStatus :: Lens' CreateActionResponse Int Source #

The response's http status code.

CreateAlgorithm

createAlgorithm_algorithmDescription :: Lens' CreateAlgorithm (Maybe Text) Source #

A description of the algorithm.

createAlgorithm_certifyForMarketplace :: Lens' CreateAlgorithm (Maybe Bool) Source #

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

createAlgorithm_inferenceSpecification :: Lens' CreateAlgorithm (Maybe InferenceSpecification) Source #

Specifies details about inference jobs that the algorithm runs, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.
  • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.
  • The input and output content formats that the algorithm supports for inference.

createAlgorithm_tags :: Lens' CreateAlgorithm (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createAlgorithm_validationSpecification :: Lens' CreateAlgorithm (Maybe AlgorithmValidationSpecification) Source #

Specifies configurations for one or more training jobs and that SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that SageMaker runs to test the algorithm's inference code.

createAlgorithm_algorithmName :: Lens' CreateAlgorithm Text Source #

The name of the algorithm.

createAlgorithm_trainingSpecification :: Lens' CreateAlgorithm TrainingSpecification Source #

Specifies details about training jobs run by this algorithm, including the following:

  • The Amazon ECR path of the container and the version digest of the algorithm.
  • The hyperparameters that the algorithm supports.
  • The instance types that the algorithm supports for training.
  • Whether the algorithm supports distributed training.
  • The metrics that the algorithm emits to Amazon CloudWatch.
  • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.
  • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

createAlgorithmResponse_httpStatus :: Lens' CreateAlgorithmResponse Int Source #

The response's http status code.

createAlgorithmResponse_algorithmArn :: Lens' CreateAlgorithmResponse Text Source #

The Amazon Resource Name (ARN) of the new algorithm.

CreateApp

createApp_resourceSpec :: Lens' CreateApp (Maybe ResourceSpec) Source #

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

The value of InstanceType passed as part of the ResourceSpec in the CreateApp call overrides the value passed as part of the ResourceSpec configured for the user profile or the domain. If InstanceType is not specified in any of those three ResourceSpec values for a KernelGateway app, the CreateApp call fails with a request validation error.

createApp_spaceName :: Lens' CreateApp (Maybe Text) Source #

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

createApp_tags :: Lens' CreateApp (Maybe [Tag]) Source #

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

createApp_userProfileName :: Lens' CreateApp (Maybe Text) Source #

The user profile name. If this value is not set, then SpaceName must be set.

createApp_domainId :: Lens' CreateApp Text Source #

The domain ID.

createApp_appType :: Lens' CreateApp AppType Source #

The type of app.

createApp_appName :: Lens' CreateApp Text Source #

The name of the app.

createAppResponse_appArn :: Lens' CreateAppResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the app.

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.

CreateAppImageConfig

createAppImageConfig_kernelGatewayImageConfig :: Lens' CreateAppImageConfig (Maybe KernelGatewayImageConfig) Source #

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

createAppImageConfig_tags :: Lens' CreateAppImageConfig (Maybe [Tag]) Source #

A list of tags to apply to the AppImageConfig.

createAppImageConfig_appImageConfigName :: Lens' CreateAppImageConfig Text Source #

The name of the AppImageConfig. Must be unique to your account.

createAppImageConfigResponse_appImageConfigArn :: Lens' CreateAppImageConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AppImageConfig.

createAppImageConfigResponse_httpStatus :: Lens' CreateAppImageConfigResponse Int Source #

The response's http status code.

CreateArtifact

createArtifact_artifactName :: Lens' CreateArtifact (Maybe Text) Source #

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

createArtifact_metadataProperties :: Lens' CreateArtifact (Maybe MetadataProperties) Source #

Undocumented member.

createArtifact_properties :: Lens' CreateArtifact (Maybe (HashMap Text Text)) Source #

A list of properties to add to the artifact.

createArtifact_tags :: Lens' CreateArtifact (Maybe [Tag]) Source #

A list of tags to apply to the artifact.

createArtifact_source :: Lens' CreateArtifact ArtifactSource Source #

The ID, ID type, and URI of the source.

createArtifact_artifactType :: Lens' CreateArtifact Text Source #

The artifact type.

createArtifactResponse_artifactArn :: Lens' CreateArtifactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact.

createArtifactResponse_httpStatus :: Lens' CreateArtifactResponse Int Source #

The response's http status code.

CreateAutoMLJob

createAutoMLJob_autoMLJobConfig :: Lens' CreateAutoMLJob (Maybe AutoMLJobConfig) Source #

A collection of settings used to configure an AutoML job.

createAutoMLJob_autoMLJobObjective :: Lens' CreateAutoMLJob (Maybe AutoMLJobObjective) Source #

Defines the objective metric used to measure the predictive quality of an AutoML job. You provide an AutoMLJobObjective$MetricName and Autopilot infers whether to minimize or maximize it.

createAutoMLJob_generateCandidateDefinitionsOnly :: Lens' CreateAutoMLJob (Maybe Bool) Source #

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

createAutoMLJob_modelDeployConfig :: Lens' CreateAutoMLJob (Maybe ModelDeployConfig) Source #

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

createAutoMLJob_problemType :: Lens' CreateAutoMLJob (Maybe ProblemType) Source #

Defines the type of supervised learning available for the candidates. For more information, see Amazon SageMaker Autopilot problem types and algorithm support.

createAutoMLJob_tags :: Lens' CreateAutoMLJob (Maybe [Tag]) Source #

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

createAutoMLJob_autoMLJobName :: Lens' CreateAutoMLJob Text Source #

Identifies an Autopilot job. The name must be unique to your account and is case-insensitive.

createAutoMLJob_inputDataConfig :: Lens' CreateAutoMLJob (NonEmpty AutoMLChannel) Source #

An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig supported by . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.

createAutoMLJob_outputDataConfig :: Lens' CreateAutoMLJob AutoMLOutputDataConfig Source #

Provides information about encryption and the Amazon S3 output path needed to store artifacts from an AutoML job. Format(s) supported: CSV.

createAutoMLJob_roleArn :: Lens' CreateAutoMLJob Text Source #

The ARN of the role that is used to access the data.

createAutoMLJobResponse_httpStatus :: Lens' CreateAutoMLJobResponse Int Source #

The response's http status code.

createAutoMLJobResponse_autoMLJobArn :: Lens' CreateAutoMLJobResponse Text Source #

The unique ARN assigned to the AutoML job when it is created.

CreateCodeRepository

createCodeRepository_tags :: Lens' CreateCodeRepository (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createCodeRepository_codeRepositoryName :: Lens' CreateCodeRepository Text Source #

The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

createCodeRepository_gitConfig :: Lens' CreateCodeRepository GitConfig Source #

Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

createCodeRepositoryResponse_httpStatus :: Lens' CreateCodeRepositoryResponse Int Source #

The response's http status code.

createCodeRepositoryResponse_codeRepositoryArn :: Lens' CreateCodeRepositoryResponse Text Source #

The Amazon Resource Name (ARN) of the new repository.

CreateCompilationJob

createCompilationJob_inputConfig :: Lens' CreateCompilationJob (Maybe InputConfig) Source #

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

createCompilationJob_modelPackageVersionArn :: Lens' CreateCompilationJob (Maybe Text) Source #

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

createCompilationJob_tags :: Lens' CreateCompilationJob (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createCompilationJob_vpcConfig :: Lens' CreateCompilationJob (Maybe NeoVpcConfig) Source #

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

createCompilationJob_compilationJobName :: Lens' CreateCompilationJob Text Source #

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

createCompilationJob_roleArn :: Lens' CreateCompilationJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

  • Read input data from an S3 bucket
  • Write model artifacts to an S3 bucket
  • Write logs to Amazon CloudWatch Logs
  • Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

createCompilationJob_outputConfig :: Lens' CreateCompilationJob OutputConfig Source #

Provides information about the output location for the compiled model and the target device the model runs on.

createCompilationJob_stoppingCondition :: Lens' CreateCompilationJob StoppingCondition Source #

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

createCompilationJobResponse_httpStatus :: Lens' CreateCompilationJobResponse Int Source #

The response's http status code.

createCompilationJobResponse_compilationJobArn :: Lens' CreateCompilationJobResponse Text Source #

If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

  • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

CreateContext

createContext_description :: Lens' CreateContext (Maybe Text) Source #

The description of the context.

createContext_properties :: Lens' CreateContext (Maybe (HashMap Text Text)) Source #

A list of properties to add to the context.

createContext_tags :: Lens' CreateContext (Maybe [Tag]) Source #

A list of tags to apply to the context.

createContext_contextName :: Lens' CreateContext Text Source #

The name of the context. Must be unique to your account in an Amazon Web Services Region.

createContext_source :: Lens' CreateContext ContextSource Source #

The source type, ID, and URI.

createContext_contextType :: Lens' CreateContext Text Source #

The context type.

createContextResponse_contextArn :: Lens' CreateContextResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the context.

createContextResponse_httpStatus :: Lens' CreateContextResponse Int Source #

The response's http status code.

CreateDataQualityJobDefinition

createDataQualityJobDefinition_dataQualityBaselineConfig :: Lens' CreateDataQualityJobDefinition (Maybe DataQualityBaselineConfig) Source #

Configures the constraints and baselines for the monitoring job.

createDataQualityJobDefinition_networkConfig :: Lens' CreateDataQualityJobDefinition (Maybe MonitoringNetworkConfig) Source #

Specifies networking configuration for the monitoring job.

createDataQualityJobDefinition_stoppingCondition :: Lens' CreateDataQualityJobDefinition (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

createDataQualityJobDefinition_tags :: Lens' CreateDataQualityJobDefinition (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createDataQualityJobDefinition_jobDefinitionName :: Lens' CreateDataQualityJobDefinition Text Source #

The name for the monitoring job definition.

createDataQualityJobDefinition_dataQualityAppSpecification :: Lens' CreateDataQualityJobDefinition DataQualityAppSpecification Source #

Specifies the container that runs the monitoring job.

createDataQualityJobDefinition_dataQualityJobInput :: Lens' CreateDataQualityJobDefinition DataQualityJobInput Source #

A list of inputs for the monitoring job. Currently endpoints are supported as monitoring inputs.

createDataQualityJobDefinition_dataQualityJobOutputConfig :: Lens' CreateDataQualityJobDefinition MonitoringOutputConfig Source #

Undocumented member.

createDataQualityJobDefinition_jobResources :: Lens' CreateDataQualityJobDefinition MonitoringResources Source #

Undocumented member.

createDataQualityJobDefinition_roleArn :: Lens' CreateDataQualityJobDefinition Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

createDataQualityJobDefinitionResponse_httpStatus :: Lens' CreateDataQualityJobDefinitionResponse Int Source #

The response's http status code.

createDataQualityJobDefinitionResponse_jobDefinitionArn :: Lens' CreateDataQualityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the job definition.

CreateDeviceFleet

createDeviceFleet_description :: Lens' CreateDeviceFleet (Maybe Text) Source #

A description of the fleet.

createDeviceFleet_enableIotRoleAlias :: Lens' CreateDeviceFleet (Maybe Bool) Source #

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

createDeviceFleet_roleArn :: Lens' CreateDeviceFleet (Maybe Text) Source #

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

createDeviceFleet_tags :: Lens' CreateDeviceFleet (Maybe [Tag]) Source #

Creates tags for the specified fleet.

createDeviceFleet_deviceFleetName :: Lens' CreateDeviceFleet Text Source #

The name of the fleet that the device belongs to.

createDeviceFleet_outputConfig :: Lens' CreateDeviceFleet EdgeOutputConfig Source #

The output configuration for storing sample data collected by the fleet.

CreateDomain

createDomain_appNetworkAccessType :: Lens' CreateDomain (Maybe AppNetworkAccessType) Source #

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
  • VpcOnly - All Studio traffic is through the specified VPC and subnets

createDomain_appSecurityGroupManagement :: Lens' CreateDomain (Maybe AppSecurityGroupManagement) Source #

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

createDomain_defaultSpaceSettings :: Lens' CreateDomain (Maybe DefaultSpaceSettings) Source #

The default settings used to create a space.

createDomain_domainSettings :: Lens' CreateDomain (Maybe DomainSettings) Source #

A collection of Domain settings.

createDomain_homeEfsFileSystemKmsKeyId :: Lens' CreateDomain (Maybe Text) Source #

Use KmsKeyId.

createDomain_kmsKeyId :: Lens' CreateDomain (Maybe Text) Source #

SageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, specify a customer managed key.

createDomain_tags :: Lens' CreateDomain (Maybe [Tag]) Source #

Tags to associated with the Domain. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

Tags that you specify for the Domain are also added to all Apps that the Domain launches.

createDomain_domainName :: Lens' CreateDomain Text Source #

A name for the domain.

createDomain_authMode :: Lens' CreateDomain AuthMode Source #

The mode of authentication that members use to access the domain.

createDomain_defaultUserSettings :: Lens' CreateDomain UserSettings Source #

The default settings to use to create a user profile when UserSettings isn't specified in the call to the CreateUserProfile API.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

createDomain_subnetIds :: Lens' CreateDomain (NonEmpty Text) Source #

The VPC subnets that Studio uses for communication.

createDomain_vpcId :: Lens' CreateDomain Text Source #

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

createDomainResponse_domainArn :: Lens' CreateDomainResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created domain.

createDomainResponse_url :: Lens' CreateDomainResponse (Maybe Text) Source #

The URL to the created domain.

createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #

The response's http status code.

CreateEdgeDeploymentPlan

createEdgeDeploymentPlan_stages :: Lens' CreateEdgeDeploymentPlan (Maybe [DeploymentStage]) Source #

List of stages of the edge deployment plan. The number of stages is limited to 10 per deployment.

createEdgeDeploymentPlan_tags :: Lens' CreateEdgeDeploymentPlan (Maybe [Tag]) Source #

List of tags with which to tag the edge deployment plan.

createEdgeDeploymentPlan_edgeDeploymentPlanName :: Lens' CreateEdgeDeploymentPlan Text Source #

The name of the edge deployment plan.

createEdgeDeploymentPlan_modelConfigs :: Lens' CreateEdgeDeploymentPlan [EdgeDeploymentModelConfig] Source #

List of models associated with the edge deployment plan.

createEdgeDeploymentPlan_deviceFleetName :: Lens' CreateEdgeDeploymentPlan Text Source #

The device fleet used for this edge deployment plan.

createEdgeDeploymentPlanResponse_httpStatus :: Lens' CreateEdgeDeploymentPlanResponse Int Source #

The response's http status code.

createEdgeDeploymentPlanResponse_edgeDeploymentPlanArn :: Lens' CreateEdgeDeploymentPlanResponse Text Source #

The ARN of the edge deployment plan.

CreateEdgeDeploymentStage

createEdgeDeploymentStage_edgeDeploymentPlanName :: Lens' CreateEdgeDeploymentStage Text Source #

The name of the edge deployment plan.

createEdgeDeploymentStage_stages :: Lens' CreateEdgeDeploymentStage [DeploymentStage] Source #

List of stages to be added to the edge deployment plan.

CreateEdgePackagingJob

createEdgePackagingJob_resourceKey :: Lens' CreateEdgePackagingJob (Maybe Text) Source #

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

createEdgePackagingJob_tags :: Lens' CreateEdgePackagingJob (Maybe [Tag]) Source #

Creates tags for the packaging job.

createEdgePackagingJob_edgePackagingJobName :: Lens' CreateEdgePackagingJob Text Source #

The name of the edge packaging job.

createEdgePackagingJob_compilationJobName :: Lens' CreateEdgePackagingJob Text Source #

The name of the SageMaker Neo compilation job that will be used to locate model artifacts for packaging.

createEdgePackagingJob_modelName :: Lens' CreateEdgePackagingJob Text Source #

The name of the model.

createEdgePackagingJob_modelVersion :: Lens' CreateEdgePackagingJob Text Source #

The version of the model.

createEdgePackagingJob_roleArn :: Lens' CreateEdgePackagingJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact SageMaker Neo.

createEdgePackagingJob_outputConfig :: Lens' CreateEdgePackagingJob EdgeOutputConfig Source #

Provides information about the output location for the packaged model.

CreateEndpoint

createEndpoint_deploymentConfig :: Lens' CreateEndpoint (Maybe DeploymentConfig) Source #

Undocumented member.

createEndpoint_tags :: Lens' CreateEndpoint (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createEndpoint_endpointName :: Lens' CreateEndpoint Text Source #

The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in .

createEndpoint_endpointConfigName :: Lens' CreateEndpoint Text Source #

The name of an endpoint configuration. For more information, see CreateEndpointConfig.

createEndpointResponse_httpStatus :: Lens' CreateEndpointResponse Int Source #

The response's http status code.

createEndpointResponse_endpointArn :: Lens' CreateEndpointResponse Text Source #

The Amazon Resource Name (ARN) of the endpoint.

CreateEndpointConfig

createEndpointConfig_asyncInferenceConfig :: Lens' CreateEndpointConfig (Maybe AsyncInferenceConfig) Source #

Specifies configuration for how an endpoint performs asynchronous inference. This is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync.

createEndpointConfig_dataCaptureConfig :: Lens' CreateEndpointConfig (Maybe DataCaptureConfig) Source #

Undocumented member.

createEndpointConfig_explainerConfig :: Lens' CreateEndpointConfig (Maybe ExplainerConfig) Source #

A member of CreateEndpointConfig that enables explainers.

createEndpointConfig_kmsKeyId :: Lens' CreateEndpointConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint, UpdateEndpoint requests. For more information, refer to the Amazon Web Services Key Management Service section Using Key Policies in Amazon Web Services KMS

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a KmsKeyId when using an instance type with local storage. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances with local storage, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances with local storage, the call to CreateEndpointConfig fails.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

createEndpointConfig_shadowProductionVariants :: Lens' CreateEndpointConfig (Maybe (NonEmpty ProductionVariant)) Source #

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

createEndpointConfig_tags :: Lens' CreateEndpointConfig (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createEndpointConfig_endpointConfigName :: Lens' CreateEndpointConfig Text Source #

The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

createEndpointConfig_productionVariants :: Lens' CreateEndpointConfig (NonEmpty ProductionVariant) Source #

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

createEndpointConfigResponse_httpStatus :: Lens' CreateEndpointConfigResponse Int Source #

The response's http status code.

createEndpointConfigResponse_endpointConfigArn :: Lens' CreateEndpointConfigResponse Text Source #

The Amazon Resource Name (ARN) of the endpoint configuration.

CreateExperiment

createExperiment_description :: Lens' CreateExperiment (Maybe Text) Source #

The description of the experiment.

createExperiment_displayName :: Lens' CreateExperiment (Maybe Text) Source #

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

createExperiment_tags :: Lens' CreateExperiment (Maybe [Tag]) Source #

A list of tags to associate with the experiment. You can use Search API to search on the tags.

createExperiment_experimentName :: Lens' CreateExperiment Text Source #

The name of the experiment. The name must be unique in your Amazon Web Services account and is not case-sensitive.

createExperimentResponse_experimentArn :: Lens' CreateExperimentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

createExperimentResponse_httpStatus :: Lens' CreateExperimentResponse Int Source #

The response's http status code.

CreateFeatureGroup

createFeatureGroup_description :: Lens' CreateFeatureGroup (Maybe Text) Source #

A free-form description of a FeatureGroup.

createFeatureGroup_offlineStoreConfig :: Lens' CreateFeatureGroup (Maybe OfflineStoreConfig) Source #

Use this to configure an OfflineFeatureStore. This parameter allows you to specify:

  • The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.
  • A configuration for an Amazon Web Services Glue or Amazon Web Services Hive data catalog.
  • An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore. If KMS encryption key is not specified, by default we encrypt all data at rest using Amazon Web Services KMS key. By defining your bucket-level key for SSE, you can reduce Amazon Web Services KMS requests costs by up to 99 percent.
  • Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

To learn more about this parameter, see OfflineStoreConfig.

createFeatureGroup_onlineStoreConfig :: Lens' CreateFeatureGroup (Maybe OnlineStoreConfig) Source #

You can turn the OnlineStore on or off by specifying True for the EnableOnlineStore flag in OnlineStoreConfig; the default value is False.

You can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest encryption of the OnlineStore.

createFeatureGroup_roleArn :: Lens' CreateFeatureGroup (Maybe Text) Source #

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

createFeatureGroup_tags :: Lens' CreateFeatureGroup (Maybe [Tag]) Source #

Tags used to identify Features in each FeatureGroup.

createFeatureGroup_featureGroupName :: Lens' CreateFeatureGroup Text Source #

The name of the FeatureGroup. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account. The name:

  • Must start and end with an alphanumeric character.
  • Can only contain alphanumeric character and hyphens. Spaces are not allowed.

createFeatureGroup_recordIdentifierFeatureName :: Lens' CreateFeatureGroup Text Source #

The name of the Feature whose value uniquely identifies a Record defined in the FeatureStore. Only the latest record per identifier value will be stored in the OnlineStore. RecordIdentifierFeatureName must be one of feature definitions' names.

You use the RecordIdentifierFeatureName to access data in a FeatureStore.

This name:

  • Must start and end with an alphanumeric character.
  • Can only contains alphanumeric characters, hyphens, underscores. Spaces are not allowed.

createFeatureGroup_eventTimeFeatureName :: Lens' CreateFeatureGroup Text Source #

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

An EventTime can be a String or Fractional.

  • Fractional: EventTime feature values must be a Unix timestamp in seconds.
  • String: EventTime feature values must be an ISO-8601 string in the format. The following formats are supported yyyy-MM-dd'T'HH:mm:ssZ and yyyy-MM-dd'T'HH:mm:ss.SSSZ where yyyy, MM, and dd represent the year, month, and day respectively and HH, mm, ss, and if applicable, SSS represent the hour, month, second and milliseconds respsectively. 'T' and Z are constants.

createFeatureGroup_featureDefinitions :: Lens' CreateFeatureGroup (NonEmpty FeatureDefinition) Source #

A list of Feature names and types. Name and Type is compulsory per Feature.

Valid feature FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

createFeatureGroupResponse_httpStatus :: Lens' CreateFeatureGroupResponse Int Source #

The response's http status code.

createFeatureGroupResponse_featureGroupArn :: Lens' CreateFeatureGroupResponse Text Source #

The Amazon Resource Name (ARN) of the FeatureGroup. This is a unique identifier for the feature group.

CreateFlowDefinition

createFlowDefinition_humanLoopActivationConfig :: Lens' CreateFlowDefinition (Maybe HumanLoopActivationConfig) Source #

An object containing information about the events that trigger a human workflow.

createFlowDefinition_humanLoopRequestSource :: Lens' CreateFlowDefinition (Maybe HumanLoopRequestSource) Source #

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

createFlowDefinition_tags :: Lens' CreateFlowDefinition (Maybe [Tag]) Source #

An array of key-value pairs that contain metadata to help you categorize and organize a flow definition. Each tag consists of a key and a value, both of which you define.

createFlowDefinition_flowDefinitionName :: Lens' CreateFlowDefinition Text Source #

The name of your flow definition.

createFlowDefinition_humanLoopConfig :: Lens' CreateFlowDefinition HumanLoopConfig Source #

An object containing information about the tasks the human reviewers will perform.

createFlowDefinition_outputConfig :: Lens' CreateFlowDefinition FlowDefinitionOutputConfig Source #

An object containing information about where the human review results will be uploaded.

createFlowDefinition_roleArn :: Lens' CreateFlowDefinition Text Source #

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

createFlowDefinitionResponse_httpStatus :: Lens' CreateFlowDefinitionResponse Int Source #

The response's http status code.

createFlowDefinitionResponse_flowDefinitionArn :: Lens' CreateFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the flow definition you create.

CreateHub

createHub_hubDisplayName :: Lens' CreateHub (Maybe Text) Source #

The display name of the hub.

createHub_hubSearchKeywords :: Lens' CreateHub (Maybe [Text]) Source #

The searchable keywords for the hub.

createHub_s3StorageConfig :: Lens' CreateHub (Maybe HubS3StorageConfig) Source #

The Amazon S3 storage configuration for the hub.

createHub_tags :: Lens' CreateHub (Maybe [Tag]) Source #

Any tags to associate with the hub.

createHub_hubName :: Lens' CreateHub Text Source #

The name of the hub to create.

createHub_hubDescription :: Lens' CreateHub Text Source #

A description of the hub.

createHubResponse_httpStatus :: Lens' CreateHubResponse Int Source #

The response's http status code.

createHubResponse_hubArn :: Lens' CreateHubResponse Text Source #

The Amazon Resource Name (ARN) of the hub.

CreateHumanTaskUi

createHumanTaskUi_tags :: Lens' CreateHumanTaskUi (Maybe [Tag]) Source #

An array of key-value pairs that contain metadata to help you categorize and organize a human review workflow user interface. Each tag consists of a key and a value, both of which you define.

createHumanTaskUi_humanTaskUiName :: Lens' CreateHumanTaskUi Text Source #

The name of the user interface you are creating.

createHumanTaskUi_uiTemplate :: Lens' CreateHumanTaskUi UiTemplate Source #

Undocumented member.

createHumanTaskUiResponse_httpStatus :: Lens' CreateHumanTaskUiResponse Int Source #

The response's http status code.

createHumanTaskUiResponse_humanTaskUiArn :: Lens' CreateHumanTaskUiResponse Text Source #

The Amazon Resource Name (ARN) of the human review workflow user interface you create.

CreateHyperParameterTuningJob

createHyperParameterTuningJob_tags :: Lens' CreateHyperParameterTuningJob (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

createHyperParameterTuningJob_trainingJobDefinition :: Lens' CreateHyperParameterTuningJob (Maybe HyperParameterTrainingJobDefinition) Source #

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

createHyperParameterTuningJob_trainingJobDefinitions :: Lens' CreateHyperParameterTuningJob (Maybe (NonEmpty HyperParameterTrainingJobDefinition)) Source #

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

createHyperParameterTuningJob_warmStartConfig :: Lens' CreateHyperParameterTuningJob (Maybe HyperParameterTuningJobWarmStartConfig) Source #

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

createHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' CreateHyperParameterTuningJob Text Source #

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

createHyperParameterTuningJob_hyperParameterTuningJobConfig :: Lens' CreateHyperParameterTuningJob HyperParameterTuningJobConfig Source #

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

createHyperParameterTuningJobResponse_httpStatus :: Lens' CreateHyperParameterTuningJobResponse Int Source #

The response's http status code.

createHyperParameterTuningJobResponse_hyperParameterTuningJobArn :: Lens' CreateHyperParameterTuningJobResponse Text Source #

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

CreateImage

createImage_description :: Lens' CreateImage (Maybe Text) Source #

The description of the image.

createImage_displayName :: Lens' CreateImage (Maybe Text) Source #

The display name of the image. If not provided, ImageName is displayed.

createImage_tags :: Lens' CreateImage (Maybe [Tag]) Source #

A list of tags to apply to the image.

createImage_imageName :: Lens' CreateImage Text Source #

The name of the image. Must be unique to your account.

createImage_roleArn :: Lens' CreateImage Text Source #

The ARN of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

createImageResponse_imageArn :: Lens' CreateImageResponse (Maybe Text) Source #

The ARN of the image.

createImageResponse_httpStatus :: Lens' CreateImageResponse Int Source #

The response's http status code.

CreateImageVersion

createImageVersion_aliases :: Lens' CreateImageVersion (Maybe [Text]) Source #

A list of aliases created with the image version.

createImageVersion_horovod :: Lens' CreateImageVersion (Maybe Bool) Source #

Indicates Horovod compatibility.

createImageVersion_jobType :: Lens' CreateImageVersion (Maybe JobType) Source #

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.
  • INFERENCE: The image version is compatible with SageMaker inference jobs.
  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

createImageVersion_mLFramework :: Lens' CreateImageVersion (Maybe Text) Source #

The machine learning framework vended in the image version.

createImageVersion_processor :: Lens' CreateImageVersion (Maybe Processor) Source #

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.
  • GPU: The image version is compatible with GPU.

createImageVersion_programmingLang :: Lens' CreateImageVersion (Maybe Text) Source #

The supported programming language and its version.

createImageVersion_releaseNotes :: Lens' CreateImageVersion (Maybe Text) Source #

The maintainer description of the image version.

createImageVersion_vendorGuidance :: Lens' CreateImageVersion (Maybe VendorGuidance) Source #

The stability of the image version, specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.
  • STABLE: The image version is stable.
  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

createImageVersion_baseImage :: Lens' CreateImageVersion Text Source #

The registry path of the container image to use as the starting point for this version. The path is an Amazon Elastic Container Registry (ECR) URI in the following format:

<acct-id>.dkr.ecr.<region>.amazonaws.com/<repo-name[:tag] or [@digest]>

createImageVersion_clientToken :: Lens' CreateImageVersion Text Source #

A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.

createImageVersion_imageName :: Lens' CreateImageVersion Text Source #

The ImageName of the Image to create a version of.

createImageVersionResponse_imageVersionArn :: Lens' CreateImageVersionResponse (Maybe Text) Source #

The ARN of the image version.

createImageVersionResponse_httpStatus :: Lens' CreateImageVersionResponse Int Source #

The response's http status code.

CreateInferenceExperiment

createInferenceExperiment_dataStorageConfig :: Lens' CreateInferenceExperiment (Maybe InferenceExperimentDataStorageConfig) Source #

The Amazon S3 location and configuration for storing inference request and response data.

This is an optional parameter that you can use for data capture. For more information, see Capture data.

createInferenceExperiment_description :: Lens' CreateInferenceExperiment (Maybe Text) Source #

A description for the inference experiment.

createInferenceExperiment_kmsKey :: Lens' CreateInferenceExperiment (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. The KmsKey can be any of the following formats:

  • KMS key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS key Alias

    "alias/ExampleAlias"

  • Amazon Resource Name (ARN) of a KMS key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

createInferenceExperiment_schedule :: Lens' CreateInferenceExperiment (Maybe InferenceExperimentSchedule) Source #

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

createInferenceExperiment_tags :: Lens' CreateInferenceExperiment (Maybe [Tag]) Source #

Array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging your Amazon Web Services Resources.

createInferenceExperiment_name :: Lens' CreateInferenceExperiment Text Source #

The name for the inference experiment.

createInferenceExperiment_type :: Lens' CreateInferenceExperiment InferenceExperimentType Source #

The type of the inference experiment that you want to run. The following types of experiments are possible:

  • ShadowMode: You can use this type to validate a shadow variant. For more information, see Shadow tests.

createInferenceExperiment_roleArn :: Lens' CreateInferenceExperiment Text Source #

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.

createInferenceExperiment_endpointName :: Lens' CreateInferenceExperiment Text Source #

The name of the Amazon SageMaker endpoint on which you want to run the inference experiment.

createInferenceExperiment_modelVariants :: Lens' CreateInferenceExperiment (NonEmpty ModelVariantConfig) Source #

An array of ModelVariantConfig objects. There is one for each variant in the inference experiment. Each ModelVariantConfig object in the array describes the infrastructure configuration for the corresponding variant.

createInferenceExperiment_shadowModeConfig :: Lens' CreateInferenceExperiment ShadowModeConfig Source #

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

createInferenceExperimentResponse_httpStatus :: Lens' CreateInferenceExperimentResponse Int Source #

The response's http status code.

createInferenceExperimentResponse_inferenceExperimentArn :: Lens' CreateInferenceExperimentResponse Text Source #

The ARN for your inference experiment.

CreateInferenceRecommendationsJob

createInferenceRecommendationsJob_jobDescription :: Lens' CreateInferenceRecommendationsJob (Maybe Text) Source #

Description of the recommendation job.

createInferenceRecommendationsJob_outputConfig :: Lens' CreateInferenceRecommendationsJob (Maybe RecommendationJobOutputConfig) Source #

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

createInferenceRecommendationsJob_stoppingConditions :: Lens' CreateInferenceRecommendationsJob (Maybe RecommendationJobStoppingConditions) Source #

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

createInferenceRecommendationsJob_tags :: Lens' CreateInferenceRecommendationsJob (Maybe [Tag]) Source #

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

createInferenceRecommendationsJob_jobName :: Lens' CreateInferenceRecommendationsJob Text Source #

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

createInferenceRecommendationsJob_jobType :: Lens' CreateInferenceRecommendationsJob RecommendationJobType Source #

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

createInferenceRecommendationsJob_roleArn :: Lens' CreateInferenceRecommendationsJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

createInferenceRecommendationsJob_inputConfig :: Lens' CreateInferenceRecommendationsJob RecommendationJobInputConfig Source #

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

createInferenceRecommendationsJobResponse_httpStatus :: Lens' CreateInferenceRecommendationsJobResponse Int Source #

The response's http status code.

createInferenceRecommendationsJobResponse_jobArn :: Lens' CreateInferenceRecommendationsJobResponse Text Source #

The Amazon Resource Name (ARN) of the recommendation job.

CreateLabelingJob

createLabelingJob_labelCategoryConfigS3Uri :: Lens' CreateLabelingJob (Maybe Text) Source #

The S3 URI of the file, referred to as a /label category configuration file/, that defines the categories used to label the data objects.

For 3D point cloud and video frame task types, you can add label category attributes and frame attributes to your label category configuration file. To learn how, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For named entity recognition jobs, in addition to "labels", you must provide worker instructions in the label category configuration file using the "instructions" parameter: "instructions": {"shortInstruction":"<h1>Add header</h1><p>Add Instructions</p>", "fullInstruction":"<p>Add additional instructions.</p>"}. For details and an example, see Create a Named Entity Recognition Labeling Job (API) .

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{
"document-version": "2018-11-28",
"labels": [{"label": "label_1"},{"label": "label_2"},...{"label": "label_n"}]
}

Note the following about the label category configuration file:

  • For image classification and text classification (single and multi-label) you must specify at least two label categories. For all other task types, the minimum number of label categories required is one.
  • Each label category must be unique, you cannot specify duplicate label categories.
  • If you create a 3D point cloud or video frame adjustment or verification labeling job, you must include auditLabelAttributeName in the label category configuration. Use this parameter to enter the LabelAttributeName of the labeling job you want to adjust or verify annotations of.

createLabelingJob_labelingJobAlgorithmsConfig :: Lens' CreateLabelingJob (Maybe LabelingJobAlgorithmsConfig) Source #

Configures the information required to perform automated data labeling.

createLabelingJob_stoppingConditions :: Lens' CreateLabelingJob (Maybe LabelingJobStoppingConditions) Source #

A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

createLabelingJob_tags :: Lens' CreateLabelingJob (Maybe [Tag]) Source #

An array of key/value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createLabelingJob_labelingJobName :: Lens' CreateLabelingJob Text Source #

The name of the labeling job. This name is used to identify the job in a list of labeling jobs. Labeling job names must be unique within an Amazon Web Services account and region. LabelingJobName is not case sensitive. For example, Example-job and example-job are considered the same labeling job name by Ground Truth.

createLabelingJob_labelAttributeName :: Lens' CreateLabelingJob Text Source #

The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The LabelAttributeName must meet the following requirements.

  • The name can't end with "-metadata".

  • If you are using one of the following built-in task types, the attribute name must end with "-ref". If the task type you are using is not listed below, the attribute name must not end with "-ref".

    • Image semantic segmentation (SemanticSegmentation), and adjustment (AdjustmentSemanticSegmentation) and verification (VerificationSemanticSegmentation) labeling jobs for this task type.
    • Video frame object detection (VideoObjectDetection), and adjustment and verification (AdjustmentVideoObjectDetection) labeling jobs for this task type.
    • Video frame object tracking (VideoObjectTracking), and adjustment and verification (AdjustmentVideoObjectTracking) labeling jobs for this task type.
    • 3D point cloud semantic segmentation (3DPointCloudSemanticSegmentation), and adjustment and verification (Adjustment3DPointCloudSemanticSegmentation) labeling jobs for this task type.
    • 3D point cloud object tracking (3DPointCloudObjectTracking), and adjustment and verification (Adjustment3DPointCloudObjectTracking) labeling jobs for this task type.

If you are creating an adjustment or verification labeling job, you must use a different LabelAttributeName than the one used in the original labeling job. The original labeling job is the Ground Truth labeling job that produced the labels that you want verified or adjusted. To learn more about adjustment and verification labeling jobs, see Verify and Adjust Labels.

createLabelingJob_inputConfig :: Lens' CreateLabelingJob LabelingJobInputConfig Source #

Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

You must specify at least one of the following: S3DataSource or SnsDataSource.

  • Use SnsDataSource to specify an SNS input topic for a streaming labeling job. If you do not specify and SNS input topic ARN, Ground Truth will create a one-time labeling job that stops after all data objects in the input manifest file have been labeled.
  • Use S3DataSource to specify an input manifest file for both streaming and one-time labeling jobs. Adding an S3DataSource is optional if you use SnsDataSource to create a streaming labeling job.

If you use the Amazon Mechanical Turk workforce, your input data should not include confidential information, personal information or protected health information. Use ContentClassifiers to specify that your data is free of personally identifiable information and adult content.

createLabelingJob_outputConfig :: Lens' CreateLabelingJob LabelingJobOutputConfig Source #

The location of the output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

createLabelingJob_roleArn :: Lens' CreateLabelingJob Text Source #

The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

createLabelingJob_humanTaskConfig :: Lens' CreateLabelingJob HumanTaskConfig Source #

Configures the labeling task and how it is presented to workers; including, but not limited to price, keywords, and batch size (task count).

createLabelingJobResponse_httpStatus :: Lens' CreateLabelingJobResponse Int Source #

The response's http status code.

createLabelingJobResponse_labelingJobArn :: Lens' CreateLabelingJobResponse Text Source #

The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

CreateModel

createModel_containers :: Lens' CreateModel (Maybe [ContainerDefinition]) Source #

Specifies the containers in the inference pipeline.

createModel_enableNetworkIsolation :: Lens' CreateModel (Maybe Bool) Source #

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

createModel_inferenceExecutionConfig :: Lens' CreateModel (Maybe InferenceExecutionConfig) Source #

Specifies details of how containers in a multi-container endpoint are called.

createModel_primaryContainer :: Lens' CreateModel (Maybe ContainerDefinition) Source #

The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

createModel_tags :: Lens' CreateModel (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createModel_vpcConfig :: Lens' CreateModel (Maybe VpcConfig) Source #

A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

createModel_modelName :: Lens' CreateModel Text Source #

The name of the new model.

createModel_executionRoleArn :: Lens' CreateModel Text Source #

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

createModelResponse_httpStatus :: Lens' CreateModelResponse Int Source #

The response's http status code.

createModelResponse_modelArn :: Lens' CreateModelResponse Text Source #

The ARN of the model created in SageMaker.

CreateModelBiasJobDefinition

createModelBiasJobDefinition_modelBiasBaselineConfig :: Lens' CreateModelBiasJobDefinition (Maybe ModelBiasBaselineConfig) Source #

The baseline configuration for a model bias job.

createModelBiasJobDefinition_networkConfig :: Lens' CreateModelBiasJobDefinition (Maybe MonitoringNetworkConfig) Source #

Networking options for a model bias job.

createModelBiasJobDefinition_stoppingCondition :: Lens' CreateModelBiasJobDefinition (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

createModelBiasJobDefinition_tags :: Lens' CreateModelBiasJobDefinition (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createModelBiasJobDefinition_jobDefinitionName :: Lens' CreateModelBiasJobDefinition Text Source #

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

createModelBiasJobDefinition_modelBiasAppSpecification :: Lens' CreateModelBiasJobDefinition ModelBiasAppSpecification Source #

Configures the model bias job to run a specified Docker container image.

createModelBiasJobDefinition_modelBiasJobInput :: Lens' CreateModelBiasJobDefinition ModelBiasJobInput Source #

Inputs for the model bias job.

createModelBiasJobDefinition_modelBiasJobOutputConfig :: Lens' CreateModelBiasJobDefinition MonitoringOutputConfig Source #

Undocumented member.

createModelBiasJobDefinition_jobResources :: Lens' CreateModelBiasJobDefinition MonitoringResources Source #

Undocumented member.

createModelBiasJobDefinition_roleArn :: Lens' CreateModelBiasJobDefinition Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

createModelBiasJobDefinitionResponse_httpStatus :: Lens' CreateModelBiasJobDefinitionResponse Int Source #

The response's http status code.

createModelBiasJobDefinitionResponse_jobDefinitionArn :: Lens' CreateModelBiasJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model bias job.

CreateModelCard

createModelCard_securityConfig :: Lens' CreateModelCard (Maybe ModelCardSecurityConfig) Source #

An optional Key Management Service key to encrypt, decrypt, and re-encrypt model card content for regulated workloads with highly sensitive data.

createModelCard_tags :: Lens' CreateModelCard (Maybe [Tag]) Source #

Key-value pairs used to manage metadata for model cards.

createModelCard_modelCardName :: Lens' CreateModelCard Text Source #

The unique name of the model card.

createModelCard_content :: Lens' CreateModelCard Text Source #

The content of the model card. Content must be in model card JSON schema and provided as a string.

createModelCard_modelCardStatus :: Lens' CreateModelCard ModelCardStatus Source #

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.

createModelCardResponse_httpStatus :: Lens' CreateModelCardResponse Int Source #

The response's http status code.

createModelCardResponse_modelCardArn :: Lens' CreateModelCardResponse Text Source #

The Amazon Resource Name (ARN) of the successfully created model card.

CreateModelCardExportJob

createModelCardExportJob_modelCardVersion :: Lens' CreateModelCardExportJob (Maybe Int) Source #

The version of the model card to export. If a version is not provided, then the latest version of the model card is exported.

createModelCardExportJob_modelCardName :: Lens' CreateModelCardExportJob Text Source #

The name of the model card to export.

createModelCardExportJob_modelCardExportJobName :: Lens' CreateModelCardExportJob Text Source #

The name of the model card export job.

createModelCardExportJob_outputConfig :: Lens' CreateModelCardExportJob ModelCardExportOutputConfig Source #

The model card output configuration that specifies the Amazon S3 path for exporting.

createModelCardExportJobResponse_httpStatus :: Lens' CreateModelCardExportJobResponse Int Source #

The response's http status code.

createModelCardExportJobResponse_modelCardExportJobArn :: Lens' CreateModelCardExportJobResponse Text Source #

The Amazon Resource Name (ARN) of the model card export job.

CreateModelExplainabilityJobDefinition

createModelExplainabilityJobDefinition_modelExplainabilityBaselineConfig :: Lens' CreateModelExplainabilityJobDefinition (Maybe ModelExplainabilityBaselineConfig) Source #

The baseline configuration for a model explainability job.

createModelExplainabilityJobDefinition_networkConfig :: Lens' CreateModelExplainabilityJobDefinition (Maybe MonitoringNetworkConfig) Source #

Networking options for a model explainability job.

createModelExplainabilityJobDefinition_stoppingCondition :: Lens' CreateModelExplainabilityJobDefinition (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

createModelExplainabilityJobDefinition_tags :: Lens' CreateModelExplainabilityJobDefinition (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createModelExplainabilityJobDefinition_jobDefinitionName :: Lens' CreateModelExplainabilityJobDefinition Text Source #

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

createModelExplainabilityJobDefinition_modelExplainabilityAppSpecification :: Lens' CreateModelExplainabilityJobDefinition ModelExplainabilityAppSpecification Source #

Configures the model explainability job to run a specified Docker container image.

createModelExplainabilityJobDefinition_modelExplainabilityJobInput :: Lens' CreateModelExplainabilityJobDefinition ModelExplainabilityJobInput Source #

Inputs for the model explainability job.

createModelExplainabilityJobDefinition_modelExplainabilityJobOutputConfig :: Lens' CreateModelExplainabilityJobDefinition MonitoringOutputConfig Source #

Undocumented member.

createModelExplainabilityJobDefinition_jobResources :: Lens' CreateModelExplainabilityJobDefinition MonitoringResources Source #

Undocumented member.

createModelExplainabilityJobDefinition_roleArn :: Lens' CreateModelExplainabilityJobDefinition Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

createModelExplainabilityJobDefinitionResponse_httpStatus :: Lens' CreateModelExplainabilityJobDefinitionResponse Int Source #

The response's http status code.

createModelExplainabilityJobDefinitionResponse_jobDefinitionArn :: Lens' CreateModelExplainabilityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model explainability job.

CreateModelPackage

createModelPackage_additionalInferenceSpecifications :: Lens' CreateModelPackage (Maybe (NonEmpty AdditionalInferenceSpecificationDefinition)) Source #

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

createModelPackage_certifyForMarketplace :: Lens' CreateModelPackage (Maybe Bool) Source #

Whether to certify the model package for listing on Amazon Web Services Marketplace.

This parameter is optional for unversioned models, and does not apply to versioned models.

createModelPackage_clientToken :: Lens' CreateModelPackage (Maybe Text) Source #

A unique token that guarantees that the call to this API is idempotent.

createModelPackage_customerMetadataProperties :: Lens' CreateModelPackage (Maybe (HashMap Text Text)) Source #

The metadata properties associated with the model package versions.

createModelPackage_domain :: Lens' CreateModelPackage (Maybe Text) Source #

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

createModelPackage_driftCheckBaselines :: Lens' CreateModelPackage (Maybe DriftCheckBaselines) Source #

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

createModelPackage_inferenceSpecification :: Lens' CreateModelPackage (Maybe InferenceSpecification) Source #

Specifies details about inference jobs that can be run with models based on this model package, including the following:

  • The Amazon ECR paths of containers that contain the inference code and model artifacts.
  • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
  • The input and output content formats that the model package supports for inference.

createModelPackage_metadataProperties :: Lens' CreateModelPackage (Maybe MetadataProperties) Source #

Undocumented member.

createModelPackage_modelApprovalStatus :: Lens' CreateModelPackage (Maybe ModelApprovalStatus) Source #

Whether the model is approved for deployment.

This parameter is optional for versioned models, and does not apply to unversioned models.

For versioned models, the value of this parameter must be set to Approved to deploy the model.

createModelPackage_modelMetrics :: Lens' CreateModelPackage (Maybe ModelMetrics) Source #

A structure that contains model metrics reports.

createModelPackage_modelPackageDescription :: Lens' CreateModelPackage (Maybe Text) Source #

A description of the model package.

createModelPackage_modelPackageGroupName :: Lens' CreateModelPackage (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.

This parameter is required for versioned models, and does not apply to unversioned models.

createModelPackage_modelPackageName :: Lens' CreateModelPackage (Maybe Text) Source #

The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

This parameter is required for unversioned models. It is not applicable to versioned models.

createModelPackage_samplePayloadUrl :: Lens' CreateModelPackage (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

createModelPackage_sourceAlgorithmSpecification :: Lens' CreateModelPackage (Maybe SourceAlgorithmSpecification) Source #

Details about the algorithm that was used to create the model package.

createModelPackage_tags :: Lens' CreateModelPackage (Maybe [Tag]) Source #

A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

createModelPackage_task :: Lens' CreateModelPackage (Maybe Text) Source #

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification. The following tasks are supported by Inference Recommender: "IMAGE_CLASSIFICATION" | "OBJECT_DETECTION" | "TEXT_GENERATION" |"IMAGE_SEGMENTATION" | "FILL_MASK" | "CLASSIFICATION" | "REGRESSION" | "OTHER".

Specify "OTHER" if none of the tasks listed fit your use case.

createModelPackage_validationSpecification :: Lens' CreateModelPackage (Maybe ModelPackageValidationSpecification) Source #

Specifies configurations for one or more transform jobs that SageMaker runs to test the model package.

createModelPackageResponse_httpStatus :: Lens' CreateModelPackageResponse Int Source #

The response's http status code.

createModelPackageResponse_modelPackageArn :: Lens' CreateModelPackageResponse Text Source #

The Amazon Resource Name (ARN) of the new model package.

CreateModelPackageGroup

createModelPackageGroup_modelPackageGroupDescription :: Lens' CreateModelPackageGroup (Maybe Text) Source #

A description for the model group.

createModelPackageGroup_tags :: Lens' CreateModelPackageGroup (Maybe [Tag]) Source #

A list of key value pairs associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

createModelPackageGroup_modelPackageGroupName :: Lens' CreateModelPackageGroup Text Source #

The name of the model group.

createModelPackageGroupResponse_httpStatus :: Lens' CreateModelPackageGroupResponse Int Source #

The response's http status code.

createModelPackageGroupResponse_modelPackageGroupArn :: Lens' CreateModelPackageGroupResponse Text Source #

The Amazon Resource Name (ARN) of the model group.

CreateModelQualityJobDefinition

createModelQualityJobDefinition_modelQualityBaselineConfig :: Lens' CreateModelQualityJobDefinition (Maybe ModelQualityBaselineConfig) Source #

Specifies the constraints and baselines for the monitoring job.

createModelQualityJobDefinition_networkConfig :: Lens' CreateModelQualityJobDefinition (Maybe MonitoringNetworkConfig) Source #

Specifies the network configuration for the monitoring job.

createModelQualityJobDefinition_stoppingCondition :: Lens' CreateModelQualityJobDefinition (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

createModelQualityJobDefinition_tags :: Lens' CreateModelQualityJobDefinition (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createModelQualityJobDefinition_jobDefinitionName :: Lens' CreateModelQualityJobDefinition Text Source #

The name of the monitoring job definition.

createModelQualityJobDefinition_modelQualityAppSpecification :: Lens' CreateModelQualityJobDefinition ModelQualityAppSpecification Source #

The container that runs the monitoring job.

createModelQualityJobDefinition_modelQualityJobInput :: Lens' CreateModelQualityJobDefinition ModelQualityJobInput Source #

A list of the inputs that are monitored. Currently endpoints are supported.

createModelQualityJobDefinition_modelQualityJobOutputConfig :: Lens' CreateModelQualityJobDefinition MonitoringOutputConfig Source #

Undocumented member.

createModelQualityJobDefinition_jobResources :: Lens' CreateModelQualityJobDefinition MonitoringResources Source #

Undocumented member.

createModelQualityJobDefinition_roleArn :: Lens' CreateModelQualityJobDefinition Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

createModelQualityJobDefinitionResponse_httpStatus :: Lens' CreateModelQualityJobDefinitionResponse Int Source #

The response's http status code.

createModelQualityJobDefinitionResponse_jobDefinitionArn :: Lens' CreateModelQualityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model quality monitoring job.

CreateMonitoringSchedule

createMonitoringSchedule_tags :: Lens' CreateMonitoringSchedule (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createMonitoringSchedule_monitoringScheduleName :: Lens' CreateMonitoringSchedule Text Source #

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

createMonitoringSchedule_monitoringScheduleConfig :: Lens' CreateMonitoringSchedule MonitoringScheduleConfig Source #

The configuration object that specifies the monitoring schedule and defines the monitoring job.

createMonitoringScheduleResponse_httpStatus :: Lens' CreateMonitoringScheduleResponse Int Source #

The response's http status code.

createMonitoringScheduleResponse_monitoringScheduleArn :: Lens' CreateMonitoringScheduleResponse Text Source #

The Amazon Resource Name (ARN) of the monitoring schedule.

CreateNotebookInstance

createNotebookInstance_acceleratorTypes :: Lens' CreateNotebookInstance (Maybe [NotebookInstanceAcceleratorType]) Source #

A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

createNotebookInstance_additionalCodeRepositories :: Lens' CreateNotebookInstance (Maybe [Text]) Source #

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

createNotebookInstance_defaultCodeRepository :: Lens' CreateNotebookInstance (Maybe Text) Source #

A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

createNotebookInstance_directInternetAccess :: Lens' CreateNotebookInstance (Maybe DirectInternetAccess) Source #

Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a NAT Gateway in your VPC.

For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

createNotebookInstance_instanceMetadataServiceConfiguration :: Lens' CreateNotebookInstance (Maybe InstanceMetadataServiceConfiguration) Source #

Information on the IMDS configuration of the notebook instance

createNotebookInstance_kmsKeyId :: Lens' CreateNotebookInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the Amazon Web Services Key Management Service Developer Guide.

createNotebookInstance_lifecycleConfigName :: Lens' CreateNotebookInstance (Maybe Text) Source #

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

createNotebookInstance_platformIdentifier :: Lens' CreateNotebookInstance (Maybe Text) Source #

The platform identifier of the notebook instance runtime environment.

createNotebookInstance_rootAccess :: Lens' CreateNotebookInstance (Maybe RootAccess) Source #

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

createNotebookInstance_securityGroupIds :: Lens' CreateNotebookInstance (Maybe [Text]) Source #

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

createNotebookInstance_subnetId :: Lens' CreateNotebookInstance (Maybe Text) Source #

The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

createNotebookInstance_tags :: Lens' CreateNotebookInstance (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createNotebookInstance_volumeSizeInGB :: Lens' CreateNotebookInstance (Maybe Natural) Source #

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

createNotebookInstance_notebookInstanceName :: Lens' CreateNotebookInstance Text Source #

The name of the new notebook instance.

createNotebookInstance_instanceType :: Lens' CreateNotebookInstance InstanceType Source #

The type of ML compute instance to launch for the notebook instance.

createNotebookInstance_roleArn :: Lens' CreateNotebookInstance Text Source #

When you send any requests to Amazon Web Services resources from the notebook instance, SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so SageMaker can perform these tasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com) permissions to assume this role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

createNotebookInstanceResponse_notebookInstanceArn :: Lens' CreateNotebookInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the notebook instance.

createNotebookInstanceResponse_httpStatus :: Lens' CreateNotebookInstanceResponse Int Source #

The response's http status code.

CreateNotebookInstanceLifecycleConfig

createNotebookInstanceLifecycleConfig_onCreate :: Lens' CreateNotebookInstanceLifecycleConfig (Maybe [NotebookInstanceLifecycleHook]) Source #

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

createNotebookInstanceLifecycleConfig_onStart :: Lens' CreateNotebookInstanceLifecycleConfig (Maybe [NotebookInstanceLifecycleHook]) Source #

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

createNotebookInstanceLifecycleConfig_notebookInstanceLifecycleConfigName :: Lens' CreateNotebookInstanceLifecycleConfig Text Source #

The name of the lifecycle configuration.

createNotebookInstanceLifecycleConfigResponse_notebookInstanceLifecycleConfigArn :: Lens' CreateNotebookInstanceLifecycleConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lifecycle configuration.

createNotebookInstanceLifecycleConfigResponse_httpStatus :: Lens' CreateNotebookInstanceLifecycleConfigResponse Int Source #

The response's http status code.

CreatePipeline

createPipeline_parallelismConfiguration :: Lens' CreatePipeline (Maybe ParallelismConfiguration) Source #

This is the configuration that controls the parallelism of the pipeline. If specified, it applies to all runs of this pipeline by default.

createPipeline_pipelineDefinition :: Lens' CreatePipeline (Maybe Text) Source #

The JSON pipeline definition of the pipeline.

createPipeline_pipelineDefinitionS3Location :: Lens' CreatePipeline (Maybe PipelineDefinitionS3Location) Source #

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

createPipeline_pipelineDescription :: Lens' CreatePipeline (Maybe Text) Source #

A description of the pipeline.

createPipeline_pipelineDisplayName :: Lens' CreatePipeline (Maybe Text) Source #

The display name of the pipeline.

createPipeline_tags :: Lens' CreatePipeline (Maybe [Tag]) Source #

A list of tags to apply to the created pipeline.

createPipeline_pipelineName :: Lens' CreatePipeline Text Source #

The name of the pipeline.

createPipeline_clientRequestToken :: Lens' CreatePipeline Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

createPipeline_roleArn :: Lens' CreatePipeline Text Source #

The Amazon Resource Name (ARN) of the role used by the pipeline to access and create resources.

createPipelineResponse_pipelineArn :: Lens' CreatePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created pipeline.

createPipelineResponse_httpStatus :: Lens' CreatePipelineResponse Int Source #

The response's http status code.

CreatePresignedDomainUrl

createPresignedDomainUrl_expiresInSeconds :: Lens' CreatePresignedDomainUrl (Maybe Natural) Source #

The number of seconds until the pre-signed URL expires. This value defaults to 300.

createPresignedDomainUrl_sessionExpirationDurationInSeconds :: Lens' CreatePresignedDomainUrl (Maybe Natural) Source #

The session expiration duration in seconds. This value defaults to 43200.

createPresignedDomainUrl_spaceName :: Lens' CreatePresignedDomainUrl (Maybe Text) Source #

The name of the space.

createPresignedDomainUrl_domainId :: Lens' CreatePresignedDomainUrl Text Source #

The domain ID.

createPresignedDomainUrl_userProfileName :: Lens' CreatePresignedDomainUrl Text Source #

The name of the UserProfile to sign-in as.

createPresignedDomainUrlResponse_authorizedUrl :: Lens' CreatePresignedDomainUrlResponse (Maybe Text) Source #

The presigned URL.

createPresignedDomainUrlResponse_httpStatus :: Lens' CreatePresignedDomainUrlResponse Int Source #

The response's http status code.

CreatePresignedNotebookInstanceUrl

createPresignedNotebookInstanceUrl_sessionExpirationDurationInSeconds :: Lens' CreatePresignedNotebookInstanceUrl (Maybe Natural) Source #

The duration of the session, in seconds. The default is 12 hours.

createPresignedNotebookInstanceUrl_notebookInstanceName :: Lens' CreatePresignedNotebookInstanceUrl Text Source #

The name of the notebook instance.

createPresignedNotebookInstanceUrlResponse_authorizedUrl :: Lens' CreatePresignedNotebookInstanceUrlResponse (Maybe Text) Source #

A JSON object that contains the URL string.

createPresignedNotebookInstanceUrlResponse_httpStatus :: Lens' CreatePresignedNotebookInstanceUrlResponse Int Source #

The response's http status code.

CreateProcessingJob

createProcessingJob_environment :: Lens' CreateProcessingJob (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.

createProcessingJob_experimentConfig :: Lens' CreateProcessingJob (Maybe ExperimentConfig) Source #

Undocumented member.

createProcessingJob_networkConfig :: Lens' CreateProcessingJob (Maybe NetworkConfig) Source #

Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.

createProcessingJob_processingInputs :: Lens' CreateProcessingJob (Maybe [ProcessingInput]) Source #

An array of inputs configuring the data to download into the processing container.

createProcessingJob_processingOutputConfig :: Lens' CreateProcessingJob (Maybe ProcessingOutputConfig) Source #

Output configuration for the processing job.

createProcessingJob_stoppingCondition :: Lens' CreateProcessingJob (Maybe ProcessingStoppingCondition) Source #

The time limit for how long the processing job is allowed to run.

createProcessingJob_tags :: Lens' CreateProcessingJob (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createProcessingJob_processingJobName :: Lens' CreateProcessingJob Text Source #

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

createProcessingJob_processingResources :: Lens' CreateProcessingJob ProcessingResources Source #

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

createProcessingJob_appSpecification :: Lens' CreateProcessingJob AppSpecification Source #

Configures the processing job to run a specified Docker container image.

createProcessingJob_roleArn :: Lens' CreateProcessingJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

createProcessingJobResponse_httpStatus :: Lens' CreateProcessingJobResponse Int Source #

The response's http status code.

createProcessingJobResponse_processingJobArn :: Lens' CreateProcessingJobResponse Text Source #

The Amazon Resource Name (ARN) of the processing job.

CreateProject

createProject_projectDescription :: Lens' CreateProject (Maybe Text) Source #

A description for the project.

createProject_tags :: Lens' CreateProject (Maybe [Tag]) Source #

An array of key-value pairs that you want to use to organize and track your Amazon Web Services resource costs. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

createProject_projectName :: Lens' CreateProject Text Source #

The name of the project.

createProject_serviceCatalogProvisioningDetails :: Lens' CreateProject ServiceCatalogProvisioningDetails Source #

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

createProjectResponse_httpStatus :: Lens' CreateProjectResponse Int Source #

The response's http status code.

createProjectResponse_projectArn :: Lens' CreateProjectResponse Text Source #

The Amazon Resource Name (ARN) of the project.

createProjectResponse_projectId :: Lens' CreateProjectResponse Text Source #

The ID of the new project.

CreateSpace

createSpace_spaceSettings :: Lens' CreateSpace (Maybe SpaceSettings) Source #

A collection of space settings.

createSpace_tags :: Lens' CreateSpace (Maybe [Tag]) Source #

Tags to associated with the space. Each tag consists of a key and an optional value. Tag keys must be unique for each resource. Tags are searchable using the Search API.

createSpace_domainId :: Lens' CreateSpace Text Source #

The ID of the associated Domain.

createSpace_spaceName :: Lens' CreateSpace Text Source #

The name of the space.

createSpaceResponse_spaceArn :: Lens' CreateSpaceResponse (Maybe Text) Source #

The space's Amazon Resource Name (ARN).

createSpaceResponse_httpStatus :: Lens' CreateSpaceResponse Int Source #

The response's http status code.

CreateStudioLifecycleConfig

createStudioLifecycleConfig_tags :: Lens' CreateStudioLifecycleConfig (Maybe [Tag]) Source #

Tags to be associated with the Lifecycle Configuration. Each tag consists of a key and an optional value. Tag keys must be unique per resource. Tags are searchable using the Search API.

createStudioLifecycleConfig_studioLifecycleConfigName :: Lens' CreateStudioLifecycleConfig Text Source #

The name of the Studio Lifecycle Configuration to create.

createStudioLifecycleConfig_studioLifecycleConfigContent :: Lens' CreateStudioLifecycleConfig Text Source #

The content of your Studio Lifecycle Configuration script. This content must be base64 encoded.

createStudioLifecycleConfig_studioLifecycleConfigAppType :: Lens' CreateStudioLifecycleConfig StudioLifecycleConfigAppType Source #

The App type that the Lifecycle Configuration is attached to.

createStudioLifecycleConfigResponse_studioLifecycleConfigArn :: Lens' CreateStudioLifecycleConfigResponse (Maybe Text) Source #

The ARN of your created Lifecycle Configuration.

createStudioLifecycleConfigResponse_httpStatus :: Lens' CreateStudioLifecycleConfigResponse Int Source #

The response's http status code.

CreateTrainingJob

createTrainingJob_checkpointConfig :: Lens' CreateTrainingJob (Maybe CheckpointConfig) Source #

Contains information about the output location for managed spot training checkpoint data.

createTrainingJob_debugHookConfig :: Lens' CreateTrainingJob (Maybe DebugHookConfig) Source #

Undocumented member.

createTrainingJob_debugRuleConfigurations :: Lens' CreateTrainingJob (Maybe [DebugRuleConfiguration]) Source #

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

createTrainingJob_enableInterContainerTrafficEncryption :: Lens' CreateTrainingJob (Maybe Bool) Source #

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

createTrainingJob_enableManagedSpotTraining :: Lens' CreateTrainingJob (Maybe Bool) Source #

To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

createTrainingJob_enableNetworkIsolation :: Lens' CreateTrainingJob (Maybe Bool) Source #

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

createTrainingJob_environment :: Lens' CreateTrainingJob (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container.

createTrainingJob_experimentConfig :: Lens' CreateTrainingJob (Maybe ExperimentConfig) Source #

Undocumented member.

createTrainingJob_hyperParameters :: Lens' CreateTrainingJob (Maybe (HashMap Text Text)) Source #

Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by SageMaker, see Algorithms.

You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.

createTrainingJob_inputDataConfig :: Lens' CreateTrainingJob (Maybe (NonEmpty Channel)) Source #

An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

Depending on the input mode that the algorithm supports, SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files are available as input streams. They do not need to be downloaded.

createTrainingJob_profilerConfig :: Lens' CreateTrainingJob (Maybe ProfilerConfig) Source #

Undocumented member.

createTrainingJob_profilerRuleConfigurations :: Lens' CreateTrainingJob (Maybe [ProfilerRuleConfiguration]) Source #

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

createTrainingJob_retryStrategy :: Lens' CreateTrainingJob (Maybe RetryStrategy) Source #

The number of times to retry the job when the job fails due to an InternalServerError.

createTrainingJob_tags :: Lens' CreateTrainingJob (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

createTrainingJob_tensorBoardOutputConfig :: Lens' CreateTrainingJob (Maybe TensorBoardOutputConfig) Source #

Undocumented member.

createTrainingJob_vpcConfig :: Lens' CreateTrainingJob (Maybe VpcConfig) Source #

A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

createTrainingJob_trainingJobName :: Lens' CreateTrainingJob Text Source #

The name of the training job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

createTrainingJob_algorithmSpecification :: Lens' CreateTrainingJob AlgorithmSpecification Source #

The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

createTrainingJob_roleArn :: Lens' CreateTrainingJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.

During model training, SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

createTrainingJob_outputDataConfig :: Lens' CreateTrainingJob OutputDataConfig Source #

Specifies the path to the S3 location where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

createTrainingJob_resourceConfig :: Lens' CreateTrainingJob ResourceConfig Source #

The resources, including the ML compute instances and ML storage volumes, to use for model training.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

createTrainingJob_stoppingCondition :: Lens' CreateTrainingJob StoppingCondition Source #

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

createTrainingJobResponse_httpStatus :: Lens' CreateTrainingJobResponse Int Source #

The response's http status code.

createTrainingJobResponse_trainingJobArn :: Lens' CreateTrainingJobResponse Text Source #

The Amazon Resource Name (ARN) of the training job.

CreateTransformJob

createTransformJob_batchStrategy :: Lens' CreateTransformJob (Maybe BatchStrategy) Source #

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record // is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set the SplitType property to Line, RecordIO, or TFRecord.

To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

createTransformJob_dataCaptureConfig :: Lens' CreateTransformJob (Maybe BatchDataCaptureConfig) Source #

Configuration to control how SageMaker captures inference data.

createTransformJob_dataProcessing :: Lens' CreateTransformJob (Maybe DataProcessing) Source #

The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

createTransformJob_environment :: Lens' CreateTransformJob (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

createTransformJob_experimentConfig :: Lens' CreateTransformJob (Maybe ExperimentConfig) Source #

Undocumented member.

createTransformJob_maxConcurrentTransforms :: Lens' CreateTransformJob (Maybe Natural) Source #

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

createTransformJob_maxPayloadInMB :: Lens' CreateTransformJob (Maybe Natural) Source #

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

The value of MaxPayloadInMB cannot be greater than 100 MB. If you specify the MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms * MaxPayloadInMB) also cannot exceed 100 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

createTransformJob_modelClientConfig :: Lens' CreateTransformJob (Maybe ModelClientConfig) Source #

Configures the timeout and maximum number of retries for processing a transform job invocation.

createTransformJob_tags :: Lens' CreateTransformJob (Maybe [Tag]) Source #

(Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createTransformJob_transformJobName :: Lens' CreateTransformJob Text Source #

The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

createTransformJob_modelName :: Lens' CreateTransformJob Text Source #

The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.

createTransformJob_transformInput :: Lens' CreateTransformJob TransformInput Source #

Describes the input source and the way the transform job consumes it.

createTransformJob_transformOutput :: Lens' CreateTransformJob TransformOutput Source #

Describes the results of the transform job.

createTransformJob_transformResources :: Lens' CreateTransformJob TransformResources Source #

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

createTransformJobResponse_httpStatus :: Lens' CreateTransformJobResponse Int Source #

The response's http status code.

createTransformJobResponse_transformJobArn :: Lens' CreateTransformJobResponse Text Source #

The Amazon Resource Name (ARN) of the transform job.

CreateTrial

createTrial_displayName :: Lens' CreateTrial (Maybe Text) Source #

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

createTrial_metadataProperties :: Lens' CreateTrial (Maybe MetadataProperties) Source #

Undocumented member.

createTrial_tags :: Lens' CreateTrial (Maybe [Tag]) Source #

A list of tags to associate with the trial. You can use Search API to search on the tags.

createTrial_trialName :: Lens' CreateTrial Text Source #

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

createTrial_experimentName :: Lens' CreateTrial Text Source #

The name of the experiment to associate the trial with.

createTrialResponse_trialArn :: Lens' CreateTrialResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

createTrialResponse_httpStatus :: Lens' CreateTrialResponse Int Source #

The response's http status code.

CreateTrialComponent

createTrialComponent_displayName :: Lens' CreateTrialComponent (Maybe Text) Source #

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

createTrialComponent_endTime :: Lens' CreateTrialComponent (Maybe UTCTime) Source #

When the component ended.

createTrialComponent_inputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

createTrialComponent_metadataProperties :: Lens' CreateTrialComponent (Maybe MetadataProperties) Source #

Undocumented member.

createTrialComponent_outputArtifacts :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

createTrialComponent_parameters :: Lens' CreateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue)) Source #

The hyperparameters for the component.

createTrialComponent_startTime :: Lens' CreateTrialComponent (Maybe UTCTime) Source #

When the component started.

createTrialComponent_status :: Lens' CreateTrialComponent (Maybe TrialComponentStatus) Source #

The status of the component. States include:

  • InProgress
  • Completed
  • Failed

createTrialComponent_tags :: Lens' CreateTrialComponent (Maybe [Tag]) Source #

A list of tags to associate with the component. You can use Search API to search on the tags.

createTrialComponent_trialComponentName :: Lens' CreateTrialComponent Text Source #

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.

createTrialComponentResponse_trialComponentArn :: Lens' CreateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

createTrialComponentResponse_httpStatus :: Lens' CreateTrialComponentResponse Int Source #

The response's http status code.

CreateUserProfile

createUserProfile_singleSignOnUserIdentifier :: Lens' CreateUserProfile (Maybe Text) Source #

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

createUserProfile_singleSignOnUserValue :: Lens' CreateUserProfile (Maybe Text) Source #

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

createUserProfile_tags :: Lens' CreateUserProfile (Maybe [Tag]) Source #

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

createUserProfile_userSettings :: Lens' CreateUserProfile (Maybe UserSettings) Source #

A collection of settings.

createUserProfile_domainId :: Lens' CreateUserProfile Text Source #

The ID of the associated Domain.

createUserProfile_userProfileName :: Lens' CreateUserProfile Text Source #

A name for the UserProfile. This value is not case sensitive.

createUserProfileResponse_userProfileArn :: Lens' CreateUserProfileResponse (Maybe Text) Source #

The user profile Amazon Resource Name (ARN).

createUserProfileResponse_httpStatus :: Lens' CreateUserProfileResponse Int Source #

The response's http status code.

CreateWorkforce

createWorkforce_cognitoConfig :: Lens' CreateWorkforce (Maybe CognitoConfig) Source #

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

createWorkforce_oidcConfig :: Lens' CreateWorkforce (Maybe OidcConfig) Source #

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

createWorkforce_sourceIpConfig :: Lens' CreateWorkforce (Maybe SourceIpConfig) Source #

Undocumented member.

createWorkforce_tags :: Lens' CreateWorkforce (Maybe [Tag]) Source #

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

createWorkforce_workforceVpcConfig :: Lens' CreateWorkforce (Maybe WorkforceVpcConfigRequest) Source #

Use this parameter to configure a workforce using VPC.

createWorkforce_workforceName :: Lens' CreateWorkforce Text Source #

The name of the private workforce.

createWorkforceResponse_httpStatus :: Lens' CreateWorkforceResponse Int Source #

The response's http status code.

createWorkforceResponse_workforceArn :: Lens' CreateWorkforceResponse Text Source #

The Amazon Resource Name (ARN) of the workforce.

CreateWorkteam

createWorkteam_notificationConfiguration :: Lens' CreateWorkteam (Maybe NotificationConfiguration) Source #

Configures notification of workers regarding available or expiring work items.

createWorkteam_tags :: Lens' CreateWorkteam (Maybe [Tag]) Source #

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createWorkteam_workforceName :: Lens' CreateWorkteam (Maybe Text) Source #

The name of the workforce.

createWorkteam_workteamName :: Lens' CreateWorkteam Text Source #

The name of the work team. Use this name to identify the work team.

createWorkteam_memberDefinitions :: Lens' CreateWorkteam (NonEmpty MemberDefinition) Source #

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

createWorkteam_description :: Lens' CreateWorkteam Text Source #

A description of the work team.

createWorkteamResponse_workteamArn :: Lens' CreateWorkteamResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

createWorkteamResponse_httpStatus :: Lens' CreateWorkteamResponse Int Source #

The response's http status code.

DeleteAction

deleteAction_actionName :: Lens' DeleteAction Text Source #

The name of the action to delete.

deleteActionResponse_actionArn :: Lens' DeleteActionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the action.

deleteActionResponse_httpStatus :: Lens' DeleteActionResponse Int Source #

The response's http status code.

DeleteAlgorithm

deleteAlgorithm_algorithmName :: Lens' DeleteAlgorithm Text Source #

The name of the algorithm to delete.

DeleteApp

deleteApp_spaceName :: Lens' DeleteApp (Maybe Text) Source #

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

deleteApp_userProfileName :: Lens' DeleteApp (Maybe Text) Source #

The user profile name. If this value is not set, then SpaceName must be set.

deleteApp_domainId :: Lens' DeleteApp Text Source #

The domain ID.

deleteApp_appType :: Lens' DeleteApp AppType Source #

The type of app.

deleteApp_appName :: Lens' DeleteApp Text Source #

The name of the app.

DeleteAppImageConfig

deleteAppImageConfig_appImageConfigName :: Lens' DeleteAppImageConfig Text Source #

The name of the AppImageConfig to delete.

DeleteArtifact

deleteArtifact_artifactArn :: Lens' DeleteArtifact (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact to delete.

deleteArtifact_source :: Lens' DeleteArtifact (Maybe ArtifactSource) Source #

The URI of the source.

deleteArtifactResponse_artifactArn :: Lens' DeleteArtifactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact.

deleteArtifactResponse_httpStatus :: Lens' DeleteArtifactResponse Int Source #

The response's http status code.

DeleteAssociation

deleteAssociation_sourceArn :: Lens' DeleteAssociation Text Source #

The ARN of the source.

deleteAssociation_destinationArn :: Lens' DeleteAssociation Text Source #

The Amazon Resource Name (ARN) of the destination.

deleteAssociationResponse_destinationArn :: Lens' DeleteAssociationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the destination.

deleteAssociationResponse_sourceArn :: Lens' DeleteAssociationResponse (Maybe Text) Source #

The ARN of the source.

deleteAssociationResponse_httpStatus :: Lens' DeleteAssociationResponse Int Source #

The response's http status code.

DeleteCodeRepository

deleteCodeRepository_codeRepositoryName :: Lens' DeleteCodeRepository Text Source #

The name of the Git repository to delete.

DeleteContext

deleteContext_contextName :: Lens' DeleteContext Text Source #

The name of the context to delete.

deleteContextResponse_contextArn :: Lens' DeleteContextResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the context.

deleteContextResponse_httpStatus :: Lens' DeleteContextResponse Int Source #

The response's http status code.

DeleteDataQualityJobDefinition

deleteDataQualityJobDefinition_jobDefinitionName :: Lens' DeleteDataQualityJobDefinition Text Source #

The name of the data quality monitoring job definition to delete.

DeleteDeviceFleet

deleteDeviceFleet_deviceFleetName :: Lens' DeleteDeviceFleet Text Source #

The name of the fleet to delete.

DeleteDomain

deleteDomain_retentionPolicy :: Lens' DeleteDomain (Maybe RetentionPolicy) Source #

The retention policy for this domain, which specifies whether resources will be retained after the Domain is deleted. By default, all resources are retained (not automatically deleted).

deleteDomain_domainId :: Lens' DeleteDomain Text Source #

The domain ID.

DeleteEdgeDeploymentPlan

deleteEdgeDeploymentPlan_edgeDeploymentPlanName :: Lens' DeleteEdgeDeploymentPlan Text Source #

The name of the edge deployment plan to delete.

DeleteEdgeDeploymentStage

deleteEdgeDeploymentStage_edgeDeploymentPlanName :: Lens' DeleteEdgeDeploymentStage Text Source #

The name of the edge deployment plan from which the stage will be deleted.

deleteEdgeDeploymentStage_stageName :: Lens' DeleteEdgeDeploymentStage Text Source #

The name of the stage.

DeleteEndpoint

deleteEndpoint_endpointName :: Lens' DeleteEndpoint Text Source #

The name of the endpoint that you want to delete.

DeleteEndpointConfig

deleteEndpointConfig_endpointConfigName :: Lens' DeleteEndpointConfig Text Source #

The name of the endpoint configuration that you want to delete.

DeleteExperiment

deleteExperiment_experimentName :: Lens' DeleteExperiment Text Source #

The name of the experiment to delete.

deleteExperimentResponse_experimentArn :: Lens' DeleteExperimentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment that is being deleted.

deleteExperimentResponse_httpStatus :: Lens' DeleteExperimentResponse Int Source #

The response's http status code.

DeleteFeatureGroup

deleteFeatureGroup_featureGroupName :: Lens' DeleteFeatureGroup Text Source #

The name of the FeatureGroup you want to delete. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.

DeleteFlowDefinition

deleteFlowDefinition_flowDefinitionName :: Lens' DeleteFlowDefinition Text Source #

The name of the flow definition you are deleting.

deleteFlowDefinitionResponse_httpStatus :: Lens' DeleteFlowDefinitionResponse Int Source #

The response's http status code.

DeleteHub

deleteHub_hubName :: Lens' DeleteHub Text Source #

The name of the hub to delete.

DeleteHubContent

deleteHubContent_hubName :: Lens' DeleteHubContent Text Source #

The name of the hub that you want to delete content in.

deleteHubContent_hubContentType :: Lens' DeleteHubContent HubContentType Source #

The type of content that you want to delete from a hub.

deleteHubContent_hubContentName :: Lens' DeleteHubContent Text Source #

The name of the content that you want to delete from a hub.

deleteHubContent_hubContentVersion :: Lens' DeleteHubContent Text Source #

The version of the content that you want to delete from a hub.

DeleteHumanTaskUi

deleteHumanTaskUi_humanTaskUiName :: Lens' DeleteHumanTaskUi Text Source #

The name of the human task user interface (work task template) you want to delete.

deleteHumanTaskUiResponse_httpStatus :: Lens' DeleteHumanTaskUiResponse Int Source #

The response's http status code.

DeleteImage

deleteImage_imageName :: Lens' DeleteImage Text Source #

The name of the image to delete.

deleteImageResponse_httpStatus :: Lens' DeleteImageResponse Int Source #

The response's http status code.

DeleteImageVersion

deleteImageVersion_alias :: Lens' DeleteImageVersion (Maybe Text) Source #

The alias of the image to delete.

deleteImageVersion_version :: Lens' DeleteImageVersion (Maybe Natural) Source #

The version to delete.

deleteImageVersion_imageName :: Lens' DeleteImageVersion Text Source #

The name of the image to delete.

deleteImageVersionResponse_httpStatus :: Lens' DeleteImageVersionResponse Int Source #

The response's http status code.

DeleteInferenceExperiment

deleteInferenceExperiment_name :: Lens' DeleteInferenceExperiment Text Source #

The name of the inference experiment you want to delete.

deleteInferenceExperimentResponse_httpStatus :: Lens' DeleteInferenceExperimentResponse Int Source #

The response's http status code.

deleteInferenceExperimentResponse_inferenceExperimentArn :: Lens' DeleteInferenceExperimentResponse Text Source #

The ARN of the deleted inference experiment.

DeleteModel

deleteModel_modelName :: Lens' DeleteModel Text Source #

The name of the model to delete.

DeleteModelBiasJobDefinition

deleteModelBiasJobDefinition_jobDefinitionName :: Lens' DeleteModelBiasJobDefinition Text Source #

The name of the model bias job definition to delete.

DeleteModelCard

deleteModelCard_modelCardName :: Lens' DeleteModelCard Text Source #

The name of the model card to delete.

DeleteModelExplainabilityJobDefinition

deleteModelExplainabilityJobDefinition_jobDefinitionName :: Lens' DeleteModelExplainabilityJobDefinition Text Source #

The name of the model explainability job definition to delete.

DeleteModelPackage

deleteModelPackage_modelPackageName :: Lens' DeleteModelPackage Text Source #

The name or Amazon Resource Name (ARN) of the model package to delete.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

DeleteModelPackageGroup

deleteModelPackageGroup_modelPackageGroupName :: Lens' DeleteModelPackageGroup Text Source #

The name of the model group to delete.

DeleteModelPackageGroupPolicy

deleteModelPackageGroupPolicy_modelPackageGroupName :: Lens' DeleteModelPackageGroupPolicy Text Source #

The name of the model group for which to delete the policy.

DeleteModelQualityJobDefinition

deleteModelQualityJobDefinition_jobDefinitionName :: Lens' DeleteModelQualityJobDefinition Text Source #

The name of the model quality monitoring job definition to delete.

DeleteMonitoringSchedule

deleteMonitoringSchedule_monitoringScheduleName :: Lens' DeleteMonitoringSchedule Text Source #

The name of the monitoring schedule to delete.

DeleteNotebookInstance

deleteNotebookInstance_notebookInstanceName :: Lens' DeleteNotebookInstance Text Source #

The name of the SageMaker notebook instance to delete.

DeleteNotebookInstanceLifecycleConfig

deleteNotebookInstanceLifecycleConfig_notebookInstanceLifecycleConfigName :: Lens' DeleteNotebookInstanceLifecycleConfig Text Source #

The name of the lifecycle configuration to delete.

DeletePipeline

deletePipeline_pipelineName :: Lens' DeletePipeline Text Source #

The name of the pipeline to delete.

deletePipeline_clientRequestToken :: Lens' DeletePipeline Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

deletePipelineResponse_pipelineArn :: Lens' DeletePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline to delete.

deletePipelineResponse_httpStatus :: Lens' DeletePipelineResponse Int Source #

The response's http status code.

DeleteProject

deleteProject_projectName :: Lens' DeleteProject Text Source #

The name of the project to delete.

DeleteSpace

deleteSpace_domainId :: Lens' DeleteSpace Text Source #

The ID of the associated Domain.

deleteSpace_spaceName :: Lens' DeleteSpace Text Source #

The name of the space.

DeleteStudioLifecycleConfig

deleteStudioLifecycleConfig_studioLifecycleConfigName :: Lens' DeleteStudioLifecycleConfig Text Source #

The name of the Studio Lifecycle Configuration to delete.

DeleteTags

deleteTags_resourceArn :: Lens' DeleteTags Text Source #

The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

deleteTags_tagKeys :: Lens' DeleteTags (NonEmpty Text) Source #

An array or one or more tag keys to delete.

deleteTagsResponse_httpStatus :: Lens' DeleteTagsResponse Int Source #

The response's http status code.

DeleteTrial

deleteTrial_trialName :: Lens' DeleteTrial Text Source #

The name of the trial to delete.

deleteTrialResponse_trialArn :: Lens' DeleteTrialResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial that is being deleted.

deleteTrialResponse_httpStatus :: Lens' DeleteTrialResponse Int Source #

The response's http status code.

DeleteTrialComponent

deleteTrialComponent_trialComponentName :: Lens' DeleteTrialComponent Text Source #

The name of the component to delete.

deleteTrialComponentResponse_trialComponentArn :: Lens' DeleteTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the component is being deleted.

deleteTrialComponentResponse_httpStatus :: Lens' DeleteTrialComponentResponse Int Source #

The response's http status code.

DeleteUserProfile

deleteUserProfile_domainId :: Lens' DeleteUserProfile Text Source #

The domain ID.

deleteUserProfile_userProfileName :: Lens' DeleteUserProfile Text Source #

The user profile name.

DeleteWorkforce

deleteWorkforce_workforceName :: Lens' DeleteWorkforce Text Source #

The name of the workforce.

deleteWorkforceResponse_httpStatus :: Lens' DeleteWorkforceResponse Int Source #

The response's http status code.

DeleteWorkteam

deleteWorkteam_workteamName :: Lens' DeleteWorkteam Text Source #

The name of the work team to delete.

deleteWorkteamResponse_httpStatus :: Lens' DeleteWorkteamResponse Int Source #

The response's http status code.

deleteWorkteamResponse_success :: Lens' DeleteWorkteamResponse Bool Source #

Returns true if the work team was successfully deleted; otherwise, returns false.

DeregisterDevices

deregisterDevices_deviceFleetName :: Lens' DeregisterDevices Text Source #

The name of the fleet the devices belong to.

deregisterDevices_deviceNames :: Lens' DeregisterDevices [Text] Source #

The unique IDs of the devices.

DescribeAction

describeAction_actionName :: Lens' DescribeAction Text Source #

The name of the action to describe.

describeActionResponse_actionArn :: Lens' DescribeActionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the action.

describeActionResponse_actionName :: Lens' DescribeActionResponse (Maybe Text) Source #

The name of the action.

describeActionResponse_actionType :: Lens' DescribeActionResponse (Maybe Text) Source #

The type of the action.

describeActionResponse_createdBy :: Lens' DescribeActionResponse (Maybe UserContext) Source #

Undocumented member.

describeActionResponse_creationTime :: Lens' DescribeActionResponse (Maybe UTCTime) Source #

When the action was created.

describeActionResponse_description :: Lens' DescribeActionResponse (Maybe Text) Source #

The description of the action.

describeActionResponse_lastModifiedBy :: Lens' DescribeActionResponse (Maybe UserContext) Source #

Undocumented member.

describeActionResponse_lastModifiedTime :: Lens' DescribeActionResponse (Maybe UTCTime) Source #

When the action was last modified.

describeActionResponse_lineageGroupArn :: Lens' DescribeActionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group.

describeActionResponse_metadataProperties :: Lens' DescribeActionResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeActionResponse_properties :: Lens' DescribeActionResponse (Maybe (HashMap Text Text)) Source #

A list of the action's properties.

describeActionResponse_source :: Lens' DescribeActionResponse (Maybe ActionSource) Source #

The source of the action.

describeActionResponse_status :: Lens' DescribeActionResponse (Maybe ActionStatus) Source #

The status of the action.

describeActionResponse_httpStatus :: Lens' DescribeActionResponse Int Source #

The response's http status code.

DescribeAlgorithm

describeAlgorithm_algorithmName :: Lens' DescribeAlgorithm Text Source #

The name of the algorithm to describe.

describeAlgorithmResponse_algorithmDescription :: Lens' DescribeAlgorithmResponse (Maybe Text) Source #

A brief summary about the algorithm.

describeAlgorithmResponse_certifyForMarketplace :: Lens' DescribeAlgorithmResponse (Maybe Bool) Source #

Whether the algorithm is certified to be listed in Amazon Web Services Marketplace.

describeAlgorithmResponse_inferenceSpecification :: Lens' DescribeAlgorithmResponse (Maybe InferenceSpecification) Source #

Details about inference jobs that the algorithm runs.

describeAlgorithmResponse_productId :: Lens' DescribeAlgorithmResponse (Maybe Text) Source #

The product identifier of the algorithm.

describeAlgorithmResponse_validationSpecification :: Lens' DescribeAlgorithmResponse (Maybe AlgorithmValidationSpecification) Source #

Details about configurations for one or more training jobs that SageMaker runs to test the algorithm.

describeAlgorithmResponse_httpStatus :: Lens' DescribeAlgorithmResponse Int Source #

The response's http status code.

describeAlgorithmResponse_algorithmName :: Lens' DescribeAlgorithmResponse Text Source #

The name of the algorithm being described.

describeAlgorithmResponse_algorithmArn :: Lens' DescribeAlgorithmResponse Text Source #

The Amazon Resource Name (ARN) of the algorithm.

describeAlgorithmResponse_creationTime :: Lens' DescribeAlgorithmResponse UTCTime Source #

A timestamp specifying when the algorithm was created.

describeAlgorithmResponse_trainingSpecification :: Lens' DescribeAlgorithmResponse TrainingSpecification Source #

Details about training jobs run by this algorithm.

describeAlgorithmResponse_algorithmStatus :: Lens' DescribeAlgorithmResponse AlgorithmStatus Source #

The current status of the algorithm.

describeAlgorithmResponse_algorithmStatusDetails :: Lens' DescribeAlgorithmResponse AlgorithmStatusDetails Source #

Details about the current status of the algorithm.

DescribeApp

describeApp_spaceName :: Lens' DescribeApp (Maybe Text) Source #

The name of the space.

describeApp_userProfileName :: Lens' DescribeApp (Maybe Text) Source #

The user profile name. If this value is not set, then SpaceName must be set.

describeApp_domainId :: Lens' DescribeApp Text Source #

The domain ID.

describeApp_appType :: Lens' DescribeApp AppType Source #

The type of app.

describeApp_appName :: Lens' DescribeApp Text Source #

The name of the app.

describeAppResponse_appArn :: Lens' DescribeAppResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the app.

describeAppResponse_appName :: Lens' DescribeAppResponse (Maybe Text) Source #

The name of the app.

describeAppResponse_appType :: Lens' DescribeAppResponse (Maybe AppType) Source #

The type of app.

describeAppResponse_creationTime :: Lens' DescribeAppResponse (Maybe UTCTime) Source #

The creation time.

describeAppResponse_domainId :: Lens' DescribeAppResponse (Maybe Text) Source #

The domain ID.

describeAppResponse_failureReason :: Lens' DescribeAppResponse (Maybe Text) Source #

The failure reason.

describeAppResponse_lastHealthCheckTimestamp :: Lens' DescribeAppResponse (Maybe UTCTime) Source #

The timestamp of the last health check.

describeAppResponse_lastUserActivityTimestamp :: Lens' DescribeAppResponse (Maybe UTCTime) Source #

The timestamp of the last user's activity. LastUserActivityTimestamp is also updated when SageMaker performs health checks without user activity. As a result, this value is set to the same value as LastHealthCheckTimestamp.

describeAppResponse_resourceSpec :: Lens' DescribeAppResponse (Maybe ResourceSpec) Source #

The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

describeAppResponse_spaceName :: Lens' DescribeAppResponse (Maybe Text) Source #

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

describeAppResponse_status :: Lens' DescribeAppResponse (Maybe AppStatus) Source #

The status.

describeAppResponse_userProfileName :: Lens' DescribeAppResponse (Maybe Text) Source #

The user profile name.

describeAppResponse_httpStatus :: Lens' DescribeAppResponse Int Source #

The response's http status code.

DescribeAppImageConfig

describeAppImageConfig_appImageConfigName :: Lens' DescribeAppImageConfig Text Source #

The name of the AppImageConfig to describe.

describeAppImageConfigResponse_appImageConfigArn :: Lens' DescribeAppImageConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AppImageConfig.

describeAppImageConfigResponse_appImageConfigName :: Lens' DescribeAppImageConfigResponse (Maybe Text) Source #

The name of the AppImageConfig.

describeAppImageConfigResponse_creationTime :: Lens' DescribeAppImageConfigResponse (Maybe UTCTime) Source #

When the AppImageConfig was created.

describeAppImageConfigResponse_kernelGatewayImageConfig :: Lens' DescribeAppImageConfigResponse (Maybe KernelGatewayImageConfig) Source #

The configuration of a KernelGateway app.

describeAppImageConfigResponse_lastModifiedTime :: Lens' DescribeAppImageConfigResponse (Maybe UTCTime) Source #

When the AppImageConfig was last modified.

describeAppImageConfigResponse_httpStatus :: Lens' DescribeAppImageConfigResponse Int Source #

The response's http status code.

DescribeArtifact

describeArtifact_artifactArn :: Lens' DescribeArtifact Text Source #

The Amazon Resource Name (ARN) of the artifact to describe.

describeArtifactResponse_artifactArn :: Lens' DescribeArtifactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact.

describeArtifactResponse_artifactName :: Lens' DescribeArtifactResponse (Maybe Text) Source #

The name of the artifact.

describeArtifactResponse_artifactType :: Lens' DescribeArtifactResponse (Maybe Text) Source #

The type of the artifact.

describeArtifactResponse_createdBy :: Lens' DescribeArtifactResponse (Maybe UserContext) Source #

Undocumented member.

describeArtifactResponse_creationTime :: Lens' DescribeArtifactResponse (Maybe UTCTime) Source #

When the artifact was created.

describeArtifactResponse_lastModifiedBy :: Lens' DescribeArtifactResponse (Maybe UserContext) Source #

Undocumented member.

describeArtifactResponse_lastModifiedTime :: Lens' DescribeArtifactResponse (Maybe UTCTime) Source #

When the artifact was last modified.

describeArtifactResponse_lineageGroupArn :: Lens' DescribeArtifactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group.

describeArtifactResponse_metadataProperties :: Lens' DescribeArtifactResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeArtifactResponse_properties :: Lens' DescribeArtifactResponse (Maybe (HashMap Text Text)) Source #

A list of the artifact's properties.

describeArtifactResponse_source :: Lens' DescribeArtifactResponse (Maybe ArtifactSource) Source #

The source of the artifact.

describeArtifactResponse_httpStatus :: Lens' DescribeArtifactResponse Int Source #

The response's http status code.

DescribeAutoMLJob

describeAutoMLJob_autoMLJobName :: Lens' DescribeAutoMLJob Text Source #

Requests information about an AutoML job using its unique name.

describeAutoMLJobResponse_autoMLJobArtifacts :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobArtifacts) Source #

Returns information on the job's artifacts found in AutoMLJobArtifacts.

describeAutoMLJobResponse_autoMLJobConfig :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobConfig) Source #

Returns the configuration for the AutoML job.

describeAutoMLJobResponse_autoMLJobObjective :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLJobObjective) Source #

Returns the job's objective.

describeAutoMLJobResponse_bestCandidate :: Lens' DescribeAutoMLJobResponse (Maybe AutoMLCandidate) Source #

The best model candidate selected by SageMaker Autopilot using both the best objective metric and lowest InferenceLatency for an experiment.

describeAutoMLJobResponse_endTime :: Lens' DescribeAutoMLJobResponse (Maybe UTCTime) Source #

Returns the end time of the AutoML job.

describeAutoMLJobResponse_failureReason :: Lens' DescribeAutoMLJobResponse (Maybe Text) Source #

Returns the failure reason for an AutoML job, when applicable.

describeAutoMLJobResponse_generateCandidateDefinitionsOnly :: Lens' DescribeAutoMLJobResponse (Maybe Bool) Source #

Indicates whether the output for an AutoML job generates candidate definitions only.

describeAutoMLJobResponse_modelDeployConfig :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployConfig) Source #

Indicates whether the model was deployed automatically to an endpoint and the name of that endpoint if deployed automatically.

describeAutoMLJobResponse_modelDeployResult :: Lens' DescribeAutoMLJobResponse (Maybe ModelDeployResult) Source #

Provides information about endpoint for the model deployment.

describeAutoMLJobResponse_partialFailureReasons :: Lens' DescribeAutoMLJobResponse (Maybe (NonEmpty AutoMLPartialFailureReason)) Source #

Returns a list of reasons for partial failures within an AutoML job.

describeAutoMLJobResponse_problemType :: Lens' DescribeAutoMLJobResponse (Maybe ProblemType) Source #

Returns the job's problem type.

describeAutoMLJobResponse_resolvedAttributes :: Lens' DescribeAutoMLJobResponse (Maybe ResolvedAttributes) Source #

This contains ProblemType, AutoMLJobObjective, and CompletionCriteria. If you do not provide these values, they are auto-inferred. If you do provide them, the values used are the ones you provide.

describeAutoMLJobResponse_httpStatus :: Lens' DescribeAutoMLJobResponse Int Source #

The response's http status code.

describeAutoMLJobResponse_autoMLJobName :: Lens' DescribeAutoMLJobResponse Text Source #

Returns the name of the AutoML job.

describeAutoMLJobResponse_autoMLJobArn :: Lens' DescribeAutoMLJobResponse Text Source #

Returns the ARN of the AutoML job.

describeAutoMLJobResponse_inputDataConfig :: Lens' DescribeAutoMLJobResponse (NonEmpty AutoMLChannel) Source #

Returns the input data configuration for the AutoML job..

describeAutoMLJobResponse_outputDataConfig :: Lens' DescribeAutoMLJobResponse AutoMLOutputDataConfig Source #

Returns the job's output data config.

describeAutoMLJobResponse_roleArn :: Lens' DescribeAutoMLJobResponse Text Source #

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

describeAutoMLJobResponse_creationTime :: Lens' DescribeAutoMLJobResponse UTCTime Source #

Returns the creation time of the AutoML job.

describeAutoMLJobResponse_lastModifiedTime :: Lens' DescribeAutoMLJobResponse UTCTime Source #

Returns the job's last modified time.

describeAutoMLJobResponse_autoMLJobStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobStatus Source #

Returns the status of the AutoML job.

describeAutoMLJobResponse_autoMLJobSecondaryStatus :: Lens' DescribeAutoMLJobResponse AutoMLJobSecondaryStatus Source #

Returns the secondary status of the AutoML job.

DescribeCodeRepository

describeCodeRepository_codeRepositoryName :: Lens' DescribeCodeRepository Text Source #

The name of the Git repository to describe.

describeCodeRepositoryResponse_gitConfig :: Lens' DescribeCodeRepositoryResponse (Maybe GitConfig) Source #

Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

describeCodeRepositoryResponse_httpStatus :: Lens' DescribeCodeRepositoryResponse Int Source #

The response's http status code.

describeCodeRepositoryResponse_codeRepositoryName :: Lens' DescribeCodeRepositoryResponse Text Source #

The name of the Git repository.

describeCodeRepositoryResponse_codeRepositoryArn :: Lens' DescribeCodeRepositoryResponse Text Source #

The Amazon Resource Name (ARN) of the Git repository.

describeCodeRepositoryResponse_creationTime :: Lens' DescribeCodeRepositoryResponse UTCTime Source #

The date and time that the repository was created.

describeCodeRepositoryResponse_lastModifiedTime :: Lens' DescribeCodeRepositoryResponse UTCTime Source #

The date and time that the repository was last changed.

DescribeCompilationJob

describeCompilationJob_compilationJobName :: Lens' DescribeCompilationJob Text Source #

The name of the model compilation job that you want information about.

describeCompilationJobResponse_compilationEndTime :: Lens' DescribeCompilationJobResponse (Maybe UTCTime) Source #

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

describeCompilationJobResponse_compilationStartTime :: Lens' DescribeCompilationJobResponse (Maybe UTCTime) Source #

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

describeCompilationJobResponse_inferenceImage :: Lens' DescribeCompilationJobResponse (Maybe Text) Source #

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

describeCompilationJobResponse_modelDigests :: Lens' DescribeCompilationJobResponse (Maybe ModelDigests) Source #

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

describeCompilationJobResponse_modelPackageVersionArn :: Lens' DescribeCompilationJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

describeCompilationJobResponse_vpcConfig :: Lens' DescribeCompilationJobResponse (Maybe NeoVpcConfig) Source #

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

describeCompilationJobResponse_httpStatus :: Lens' DescribeCompilationJobResponse Int Source #

The response's http status code.

describeCompilationJobResponse_compilationJobName :: Lens' DescribeCompilationJobResponse Text Source #

The name of the model compilation job.

describeCompilationJobResponse_compilationJobArn :: Lens' DescribeCompilationJobResponse Text Source #

The Amazon Resource Name (ARN) of the model compilation job.

describeCompilationJobResponse_compilationJobStatus :: Lens' DescribeCompilationJobResponse CompilationJobStatus Source #

The status of the model compilation job.

describeCompilationJobResponse_stoppingCondition :: Lens' DescribeCompilationJobResponse StoppingCondition Source #

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

describeCompilationJobResponse_creationTime :: Lens' DescribeCompilationJobResponse UTCTime Source #

The time that the model compilation job was created.

describeCompilationJobResponse_lastModifiedTime :: Lens' DescribeCompilationJobResponse UTCTime Source #

The time that the status of the model compilation job was last modified.

describeCompilationJobResponse_failureReason :: Lens' DescribeCompilationJobResponse Text Source #

If a model compilation job failed, the reason it failed.

describeCompilationJobResponse_modelArtifacts :: Lens' DescribeCompilationJobResponse ModelArtifacts Source #

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

describeCompilationJobResponse_roleArn :: Lens' DescribeCompilationJobResponse Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

describeCompilationJobResponse_inputConfig :: Lens' DescribeCompilationJobResponse InputConfig Source #

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

describeCompilationJobResponse_outputConfig :: Lens' DescribeCompilationJobResponse OutputConfig Source #

Information about the output location for the compiled model and the target device that the model runs on.

DescribeContext

describeContext_contextName :: Lens' DescribeContext Text Source #

The name of the context to describe.

describeContextResponse_contextArn :: Lens' DescribeContextResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the context.

describeContextResponse_contextName :: Lens' DescribeContextResponse (Maybe Text) Source #

The name of the context.

describeContextResponse_contextType :: Lens' DescribeContextResponse (Maybe Text) Source #

The type of the context.

describeContextResponse_createdBy :: Lens' DescribeContextResponse (Maybe UserContext) Source #

Undocumented member.

describeContextResponse_creationTime :: Lens' DescribeContextResponse (Maybe UTCTime) Source #

When the context was created.

describeContextResponse_description :: Lens' DescribeContextResponse (Maybe Text) Source #

The description of the context.

describeContextResponse_lastModifiedBy :: Lens' DescribeContextResponse (Maybe UserContext) Source #

Undocumented member.

describeContextResponse_lastModifiedTime :: Lens' DescribeContextResponse (Maybe UTCTime) Source #

When the context was last modified.

describeContextResponse_lineageGroupArn :: Lens' DescribeContextResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group.

describeContextResponse_properties :: Lens' DescribeContextResponse (Maybe (HashMap Text Text)) Source #

A list of the context's properties.

describeContextResponse_source :: Lens' DescribeContextResponse (Maybe ContextSource) Source #

The source of the context.

describeContextResponse_httpStatus :: Lens' DescribeContextResponse Int Source #

The response's http status code.

DescribeDataQualityJobDefinition

describeDataQualityJobDefinition_jobDefinitionName :: Lens' DescribeDataQualityJobDefinition Text Source #

The name of the data quality monitoring job definition to describe.

describeDataQualityJobDefinitionResponse_dataQualityBaselineConfig :: Lens' DescribeDataQualityJobDefinitionResponse (Maybe DataQualityBaselineConfig) Source #

The constraints and baselines for the data quality monitoring job definition.

describeDataQualityJobDefinitionResponse_networkConfig :: Lens' DescribeDataQualityJobDefinitionResponse (Maybe MonitoringNetworkConfig) Source #

The networking configuration for the data quality monitoring job.

describeDataQualityJobDefinitionResponse_stoppingCondition :: Lens' DescribeDataQualityJobDefinitionResponse (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

describeDataQualityJobDefinitionResponse_httpStatus :: Lens' DescribeDataQualityJobDefinitionResponse Int Source #

The response's http status code.

describeDataQualityJobDefinitionResponse_jobDefinitionArn :: Lens' DescribeDataQualityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the data quality monitoring job definition.

describeDataQualityJobDefinitionResponse_jobDefinitionName :: Lens' DescribeDataQualityJobDefinitionResponse Text Source #

The name of the data quality monitoring job definition.

describeDataQualityJobDefinitionResponse_creationTime :: Lens' DescribeDataQualityJobDefinitionResponse UTCTime Source #

The time that the data quality monitoring job definition was created.

describeDataQualityJobDefinitionResponse_dataQualityAppSpecification :: Lens' DescribeDataQualityJobDefinitionResponse DataQualityAppSpecification Source #

Information about the container that runs the data quality monitoring job.

describeDataQualityJobDefinitionResponse_dataQualityJobInput :: Lens' DescribeDataQualityJobDefinitionResponse DataQualityJobInput Source #

The list of inputs for the data quality monitoring job. Currently endpoints are supported.

describeDataQualityJobDefinitionResponse_dataQualityJobOutputConfig :: Lens' DescribeDataQualityJobDefinitionResponse MonitoringOutputConfig Source #

Undocumented member.

describeDataQualityJobDefinitionResponse_jobResources :: Lens' DescribeDataQualityJobDefinitionResponse MonitoringResources Source #

Undocumented member.

describeDataQualityJobDefinitionResponse_roleArn :: Lens' DescribeDataQualityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

DescribeDevice

describeDevice_nextToken :: Lens' DescribeDevice (Maybe Text) Source #

Next token of device description.

describeDevice_deviceName :: Lens' DescribeDevice Text Source #

The unique ID of the device.

describeDevice_deviceFleetName :: Lens' DescribeDevice Text Source #

The name of the fleet the devices belong to.

describeDeviceResponse_agentVersion :: Lens' DescribeDeviceResponse (Maybe Text) Source #

Edge Manager agent version.

describeDeviceResponse_description :: Lens' DescribeDeviceResponse (Maybe Text) Source #

A description of the device.

describeDeviceResponse_deviceArn :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device.

describeDeviceResponse_iotThingName :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device.

describeDeviceResponse_latestHeartbeat :: Lens' DescribeDeviceResponse (Maybe UTCTime) Source #

The last heartbeat received from the device.

describeDeviceResponse_maxModels :: Lens' DescribeDeviceResponse (Maybe Int) Source #

The maximum number of models.

describeDeviceResponse_models :: Lens' DescribeDeviceResponse (Maybe [EdgeModel]) Source #

Models on the device.

describeDeviceResponse_nextToken :: Lens' DescribeDeviceResponse (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

describeDeviceResponse_httpStatus :: Lens' DescribeDeviceResponse Int Source #

The response's http status code.

describeDeviceResponse_deviceName :: Lens' DescribeDeviceResponse Text Source #

The unique identifier of the device.

describeDeviceResponse_deviceFleetName :: Lens' DescribeDeviceResponse Text Source #

The name of the fleet the device belongs to.

describeDeviceResponse_registrationTime :: Lens' DescribeDeviceResponse UTCTime Source #

The timestamp of the last registration or de-reregistration.

DescribeDeviceFleet

describeDeviceFleet_deviceFleetName :: Lens' DescribeDeviceFleet Text Source #

The name of the fleet.

describeDeviceFleetResponse_description :: Lens' DescribeDeviceFleetResponse (Maybe Text) Source #

A description of the fleet.

describeDeviceFleetResponse_iotRoleAlias :: Lens' DescribeDeviceFleetResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) alias created in Amazon Web Services Internet of Things (IoT).

describeDeviceFleetResponse_roleArn :: Lens' DescribeDeviceFleetResponse (Maybe Text) Source #

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

describeDeviceFleetResponse_httpStatus :: Lens' DescribeDeviceFleetResponse Int Source #

The response's http status code.

describeDeviceFleetResponse_deviceFleetName :: Lens' DescribeDeviceFleetResponse Text Source #

The name of the fleet.

describeDeviceFleetResponse_deviceFleetArn :: Lens' DescribeDeviceFleetResponse Text Source #

The The Amazon Resource Name (ARN) of the fleet.

describeDeviceFleetResponse_outputConfig :: Lens' DescribeDeviceFleetResponse EdgeOutputConfig Source #

The output configuration for storing sampled data.

describeDeviceFleetResponse_creationTime :: Lens' DescribeDeviceFleetResponse UTCTime Source #

Timestamp of when the device fleet was created.

describeDeviceFleetResponse_lastModifiedTime :: Lens' DescribeDeviceFleetResponse UTCTime Source #

Timestamp of when the device fleet was last updated.

DescribeDomain

describeDomain_domainId :: Lens' DescribeDomain Text Source #

The domain ID.

describeDomainResponse_appNetworkAccessType :: Lens' DescribeDomainResponse (Maybe AppNetworkAccessType) Source #

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

  • PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access
  • VpcOnly - All Studio traffic is through the specified VPC and subnets

describeDomainResponse_appSecurityGroupManagement :: Lens' DescribeDomainResponse (Maybe AppSecurityGroupManagement) Source #

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

describeDomainResponse_authMode :: Lens' DescribeDomainResponse (Maybe AuthMode) Source #

The domain's authentication mode.

describeDomainResponse_creationTime :: Lens' DescribeDomainResponse (Maybe UTCTime) Source #

The creation time.

describeDomainResponse_defaultSpaceSettings :: Lens' DescribeDomainResponse (Maybe DefaultSpaceSettings) Source #

The default settings used to create a space.

describeDomainResponse_defaultUserSettings :: Lens' DescribeDomainResponse (Maybe UserSettings) Source #

Settings which are applied to UserProfiles in this domain if settings are not explicitly specified in a given UserProfile.

describeDomainResponse_domainArn :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain's Amazon Resource Name (ARN).

describeDomainResponse_domainId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain ID.

describeDomainResponse_domainName :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain name.

describeDomainResponse_domainSettings :: Lens' DescribeDomainResponse (Maybe DomainSettings) Source #

A collection of Domain settings.

describeDomainResponse_failureReason :: Lens' DescribeDomainResponse (Maybe Text) Source #

The failure reason.

describeDomainResponse_homeEfsFileSystemId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

describeDomainResponse_homeEfsFileSystemKmsKeyId :: Lens' DescribeDomainResponse (Maybe Text) Source #

Use KmsKeyId.

describeDomainResponse_kmsKeyId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The Amazon Web Services KMS customer managed key used to encrypt the EFS volume attached to the domain.

describeDomainResponse_lastModifiedTime :: Lens' DescribeDomainResponse (Maybe UTCTime) Source #

The last modified time.

describeDomainResponse_securityGroupIdForDomainBoundary :: Lens' DescribeDomainResponse (Maybe Text) Source #

The ID of the security group that authorizes traffic between the RSessionGateway apps and the RStudioServerPro app.

describeDomainResponse_singleSignOnManagedApplicationInstanceId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The IAM Identity Center managed application instance ID.

describeDomainResponse_status :: Lens' DescribeDomainResponse (Maybe DomainStatus) Source #

The status.

describeDomainResponse_subnetIds :: Lens' DescribeDomainResponse (Maybe (NonEmpty Text)) Source #

The VPC subnets that Studio uses for communication.

describeDomainResponse_url :: Lens' DescribeDomainResponse (Maybe Text) Source #

The domain's URL.

describeDomainResponse_vpcId :: Lens' DescribeDomainResponse (Maybe Text) Source #

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #

The response's http status code.

DescribeEdgeDeploymentPlan

describeEdgeDeploymentPlan_maxResults :: Lens' DescribeEdgeDeploymentPlan (Maybe Int) Source #

The maximum number of results to select (50 by default).

describeEdgeDeploymentPlan_nextToken :: Lens' DescribeEdgeDeploymentPlan (Maybe Text) Source #

If the edge deployment plan has enough stages to require tokening, then this is the response from the last list of stages returned.

describeEdgeDeploymentPlan_edgeDeploymentPlanName :: Lens' DescribeEdgeDeploymentPlan Text Source #

The name of the deployment plan to describe.

describeEdgeDeploymentPlanResponse_creationTime :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe UTCTime) Source #

The time when the edge deployment plan was created.

describeEdgeDeploymentPlanResponse_edgeDeploymentFailed :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Int) Source #

The number of edge devices that failed the deployment.

describeEdgeDeploymentPlanResponse_edgeDeploymentPending :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Int) Source #

The number of edge devices yet to pick up deployment, or in progress.

describeEdgeDeploymentPlanResponse_edgeDeploymentSuccess :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Int) Source #

The number of edge devices with the successful deployment.

describeEdgeDeploymentPlanResponse_lastModifiedTime :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe UTCTime) Source #

The time when the edge deployment plan was last updated.

describeEdgeDeploymentPlanResponse_nextToken :: Lens' DescribeEdgeDeploymentPlanResponse (Maybe Text) Source #

Token to use when calling the next set of stages in the edge deployment plan.

describeEdgeDeploymentPlanResponse_httpStatus :: Lens' DescribeEdgeDeploymentPlanResponse Int Source #

The response's http status code.

describeEdgeDeploymentPlanResponse_edgeDeploymentPlanArn :: Lens' DescribeEdgeDeploymentPlanResponse Text Source #

The ARN of edge deployment plan.

describeEdgeDeploymentPlanResponse_edgeDeploymentPlanName :: Lens' DescribeEdgeDeploymentPlanResponse Text Source #

The name of the edge deployment plan.

describeEdgeDeploymentPlanResponse_modelConfigs :: Lens' DescribeEdgeDeploymentPlanResponse [EdgeDeploymentModelConfig] Source #

List of models associated with the edge deployment plan.

describeEdgeDeploymentPlanResponse_deviceFleetName :: Lens' DescribeEdgeDeploymentPlanResponse Text Source #

The device fleet used for this edge deployment plan.

describeEdgeDeploymentPlanResponse_stages :: Lens' DescribeEdgeDeploymentPlanResponse [DeploymentStageStatusSummary] Source #

List of stages in the edge deployment plan.

DescribeEdgePackagingJob

describeEdgePackagingJob_edgePackagingJobName :: Lens' DescribeEdgePackagingJob Text Source #

The name of the edge packaging job.

describeEdgePackagingJobResponse_compilationJobName :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The name of the SageMaker Neo compilation job that is used to locate model artifacts that are being packaged.

describeEdgePackagingJobResponse_creationTime :: Lens' DescribeEdgePackagingJobResponse (Maybe UTCTime) Source #

The timestamp of when the packaging job was created.

describeEdgePackagingJobResponse_edgePackagingJobStatusMessage :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

Returns a message describing the job status and error messages.

describeEdgePackagingJobResponse_lastModifiedTime :: Lens' DescribeEdgePackagingJobResponse (Maybe UTCTime) Source #

The timestamp of when the job was last updated.

describeEdgePackagingJobResponse_modelArtifact :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The Amazon Simple Storage (S3) URI where model artifacts ares stored.

describeEdgePackagingJobResponse_modelName :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The name of the model.

describeEdgePackagingJobResponse_modelSignature :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The signature document of files in the model artifact.

describeEdgePackagingJobResponse_modelVersion :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The version of the model.

describeEdgePackagingJobResponse_outputConfig :: Lens' DescribeEdgePackagingJobResponse (Maybe EdgeOutputConfig) Source #

The output configuration for the edge packaging job.

describeEdgePackagingJobResponse_presetDeploymentOutput :: Lens' DescribeEdgePackagingJobResponse (Maybe EdgePresetDeploymentOutput) Source #

The output of a SageMaker Edge Manager deployable resource.

describeEdgePackagingJobResponse_resourceKey :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The Amazon Web Services KMS key to use when encrypting the EBS volume the job run on.

describeEdgePackagingJobResponse_roleArn :: Lens' DescribeEdgePackagingJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to download and upload the model, and to contact Neo.

describeEdgePackagingJobResponse_httpStatus :: Lens' DescribeEdgePackagingJobResponse Int Source #

The response's http status code.

describeEdgePackagingJobResponse_edgePackagingJobArn :: Lens' DescribeEdgePackagingJobResponse Text Source #

The Amazon Resource Name (ARN) of the edge packaging job.

describeEdgePackagingJobResponse_edgePackagingJobName :: Lens' DescribeEdgePackagingJobResponse Text Source #

The name of the edge packaging job.

describeEdgePackagingJobResponse_edgePackagingJobStatus :: Lens' DescribeEdgePackagingJobResponse EdgePackagingJobStatus Source #

The current status of the packaging job.

DescribeEndpoint

describeEndpoint_endpointName :: Lens' DescribeEndpoint Text Source #

The name of the endpoint.

describeEndpointResponse_asyncInferenceConfig :: Lens' DescribeEndpointResponse (Maybe AsyncInferenceConfig) Source #

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

describeEndpointResponse_dataCaptureConfig :: Lens' DescribeEndpointResponse (Maybe DataCaptureConfigSummary) Source #

Undocumented member.

describeEndpointResponse_explainerConfig :: Lens' DescribeEndpointResponse (Maybe ExplainerConfig) Source #

The configuration parameters for an explainer.

describeEndpointResponse_failureReason :: Lens' DescribeEndpointResponse (Maybe Text) Source #

If the status of the endpoint is Failed, the reason why it failed.

describeEndpointResponse_lastDeploymentConfig :: Lens' DescribeEndpointResponse (Maybe DeploymentConfig) Source #

The most recent deployment configuration for the endpoint.

describeEndpointResponse_pendingDeploymentSummary :: Lens' DescribeEndpointResponse (Maybe PendingDeploymentSummary) Source #

Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.

describeEndpointResponse_productionVariants :: Lens' DescribeEndpointResponse (Maybe (NonEmpty ProductionVariantSummary)) Source #

An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

describeEndpointResponse_shadowProductionVariants :: Lens' DescribeEndpointResponse (Maybe (NonEmpty ProductionVariantSummary)) Source #

An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

describeEndpointResponse_httpStatus :: Lens' DescribeEndpointResponse Int Source #

The response's http status code.

describeEndpointResponse_endpointName :: Lens' DescribeEndpointResponse Text Source #

Name of the endpoint.

describeEndpointResponse_endpointArn :: Lens' DescribeEndpointResponse Text Source #

The Amazon Resource Name (ARN) of the endpoint.

describeEndpointResponse_endpointConfigName :: Lens' DescribeEndpointResponse Text Source #

The name of the endpoint configuration associated with this endpoint.

describeEndpointResponse_endpointStatus :: Lens' DescribeEndpointResponse EndpointStatus Source #

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.
  • Creating: CreateEndpoint is executing.
  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.
  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.
  • InService: Endpoint is available to process incoming requests.
  • Deleting: DeleteEndpoint is executing.
  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

describeEndpointResponse_creationTime :: Lens' DescribeEndpointResponse UTCTime Source #

A timestamp that shows when the endpoint was created.

describeEndpointResponse_lastModifiedTime :: Lens' DescribeEndpointResponse UTCTime Source #

A timestamp that shows when the endpoint was last modified.

DescribeEndpointConfig

describeEndpointConfig_endpointConfigName :: Lens' DescribeEndpointConfig Text Source #

The name of the endpoint configuration.

describeEndpointConfigResponse_asyncInferenceConfig :: Lens' DescribeEndpointConfigResponse (Maybe AsyncInferenceConfig) Source #

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

describeEndpointConfigResponse_dataCaptureConfig :: Lens' DescribeEndpointConfigResponse (Maybe DataCaptureConfig) Source #

Undocumented member.

describeEndpointConfigResponse_explainerConfig :: Lens' DescribeEndpointConfigResponse (Maybe ExplainerConfig) Source #

The configuration parameters for an explainer.

describeEndpointConfigResponse_kmsKeyId :: Lens' DescribeEndpointConfigResponse (Maybe Text) Source #

Amazon Web Services KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

describeEndpointConfigResponse_shadowProductionVariants :: Lens' DescribeEndpointConfigResponse (Maybe (NonEmpty ProductionVariant)) Source #

An array of ProductionVariant objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants.

describeEndpointConfigResponse_httpStatus :: Lens' DescribeEndpointConfigResponse Int Source #

The response's http status code.

describeEndpointConfigResponse_endpointConfigName :: Lens' DescribeEndpointConfigResponse Text Source #

Name of the SageMaker endpoint configuration.

describeEndpointConfigResponse_endpointConfigArn :: Lens' DescribeEndpointConfigResponse Text Source #

The Amazon Resource Name (ARN) of the endpoint configuration.

describeEndpointConfigResponse_productionVariants :: Lens' DescribeEndpointConfigResponse (NonEmpty ProductionVariant) Source #

An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

describeEndpointConfigResponse_creationTime :: Lens' DescribeEndpointConfigResponse UTCTime Source #

A timestamp that shows when the endpoint configuration was created.

DescribeExperiment

describeExperiment_experimentName :: Lens' DescribeExperiment Text Source #

The name of the experiment to describe.

describeExperimentResponse_createdBy :: Lens' DescribeExperimentResponse (Maybe UserContext) Source #

Who created the experiment.

describeExperimentResponse_creationTime :: Lens' DescribeExperimentResponse (Maybe UTCTime) Source #

When the experiment was created.

describeExperimentResponse_description :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The description of the experiment.

describeExperimentResponse_displayName :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

describeExperimentResponse_experimentArn :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

describeExperimentResponse_experimentName :: Lens' DescribeExperimentResponse (Maybe Text) Source #

The name of the experiment.

describeExperimentResponse_lastModifiedBy :: Lens' DescribeExperimentResponse (Maybe UserContext) Source #

Who last modified the experiment.

describeExperimentResponse_lastModifiedTime :: Lens' DescribeExperimentResponse (Maybe UTCTime) Source #

When the experiment was last modified.

describeExperimentResponse_source :: Lens' DescribeExperimentResponse (Maybe ExperimentSource) Source #

The Amazon Resource Name (ARN) of the source and, optionally, the type.

describeExperimentResponse_httpStatus :: Lens' DescribeExperimentResponse Int Source #

The response's http status code.

DescribeFeatureGroup

describeFeatureGroup_nextToken :: Lens' DescribeFeatureGroup (Maybe Text) Source #

A token to resume pagination of the list of Features (FeatureDefinitions). 2,500 Features are returned by default.

describeFeatureGroup_featureGroupName :: Lens' DescribeFeatureGroup Text Source #

The name of the FeatureGroup you want described.

describeFeatureGroupResponse_description :: Lens' DescribeFeatureGroupResponse (Maybe Text) Source #

A free form description of the feature group.

describeFeatureGroupResponse_failureReason :: Lens' DescribeFeatureGroupResponse (Maybe Text) Source #

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure can occur because:

  • The FeatureGroup could not be created in the OfflineStore.
  • The FeatureGroup could not be deleted from the OfflineStore.

describeFeatureGroupResponse_featureGroupStatus :: Lens' DescribeFeatureGroupResponse (Maybe FeatureGroupStatus) Source #

The status of the feature group.

describeFeatureGroupResponse_lastModifiedTime :: Lens' DescribeFeatureGroupResponse (Maybe UTCTime) Source #

A timestamp indicating when the feature group was last updated.

describeFeatureGroupResponse_lastUpdateStatus :: Lens' DescribeFeatureGroupResponse (Maybe LastUpdateStatus) Source #

A value indicating whether the update made to the feature group was successful.

describeFeatureGroupResponse_offlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe OfflineStoreConfig) Source #

The configuration of the offline store. It includes the following configurations:

  • Amazon S3 location of the offline store.
  • Configuration of the Glue data catalog.
  • Table format of the offline store.
  • Option to disable the automatic creation of a Glue table for the offline store.
  • Encryption configuration.

describeFeatureGroupResponse_offlineStoreStatus :: Lens' DescribeFeatureGroupResponse (Maybe OfflineStoreStatus) Source #

The status of the OfflineStore. Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked

describeFeatureGroupResponse_onlineStoreConfig :: Lens' DescribeFeatureGroupResponse (Maybe OnlineStoreConfig) Source #

The configuration for the OnlineStore.

describeFeatureGroupResponse_onlineStoreTotalSizeBytes :: Lens' DescribeFeatureGroupResponse (Maybe Integer) Source #

The size of the OnlineStore in bytes.

describeFeatureGroupResponse_roleArn :: Lens' DescribeFeatureGroupResponse (Maybe Text) Source #

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

describeFeatureGroupResponse_httpStatus :: Lens' DescribeFeatureGroupResponse Int Source #

The response's http status code.

describeFeatureGroupResponse_featureGroupArn :: Lens' DescribeFeatureGroupResponse Text Source #

The Amazon Resource Name (ARN) of the FeatureGroup.

describeFeatureGroupResponse_featureGroupName :: Lens' DescribeFeatureGroupResponse Text Source #

he name of the FeatureGroup.

describeFeatureGroupResponse_recordIdentifierFeatureName :: Lens' DescribeFeatureGroupResponse Text Source #

The name of the Feature used for RecordIdentifier, whose value uniquely identifies a record stored in the feature store.

describeFeatureGroupResponse_eventTimeFeatureName :: Lens' DescribeFeatureGroupResponse Text Source #

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

An EventTime is a point in time when a new event occurs that corresponds to the creation or update of a Record in a FeatureGroup. All Records in the FeatureGroup have a corresponding EventTime.

describeFeatureGroupResponse_featureDefinitions :: Lens' DescribeFeatureGroupResponse (NonEmpty FeatureDefinition) Source #

A list of the Features in the FeatureGroup. Each feature is defined by a FeatureName and FeatureType.

describeFeatureGroupResponse_creationTime :: Lens' DescribeFeatureGroupResponse UTCTime Source #

A timestamp indicating when SageMaker created the FeatureGroup.

describeFeatureGroupResponse_nextToken :: Lens' DescribeFeatureGroupResponse Text Source #

A token to resume pagination of the list of Features (FeatureDefinitions).

DescribeFeatureMetadata

describeFeatureMetadata_featureGroupName :: Lens' DescribeFeatureMetadata Text Source #

The name of the feature group containing the feature.

describeFeatureMetadata_featureName :: Lens' DescribeFeatureMetadata Text Source #

The name of the feature.

describeFeatureMetadataResponse_description :: Lens' DescribeFeatureMetadataResponse (Maybe Text) Source #

The description you added to describe the feature.

describeFeatureMetadataResponse_parameters :: Lens' DescribeFeatureMetadataResponse (Maybe [FeatureParameter]) Source #

The key-value pairs that you added to describe the feature.

describeFeatureMetadataResponse_httpStatus :: Lens' DescribeFeatureMetadataResponse Int Source #

The response's http status code.

describeFeatureMetadataResponse_featureGroupArn :: Lens' DescribeFeatureMetadataResponse Text Source #

The Amazon Resource Number (ARN) of the feature group that contains the feature.

describeFeatureMetadataResponse_featureGroupName :: Lens' DescribeFeatureMetadataResponse Text Source #

The name of the feature group that you've specified.

describeFeatureMetadataResponse_featureName :: Lens' DescribeFeatureMetadataResponse Text Source #

The name of the feature that you've specified.

describeFeatureMetadataResponse_featureType :: Lens' DescribeFeatureMetadataResponse FeatureType Source #

The data type of the feature.

describeFeatureMetadataResponse_creationTime :: Lens' DescribeFeatureMetadataResponse UTCTime Source #

A timestamp indicating when the feature was created.

describeFeatureMetadataResponse_lastModifiedTime :: Lens' DescribeFeatureMetadataResponse UTCTime Source #

A timestamp indicating when the metadata for the feature group was modified. For example, if you add a parameter describing the feature, the timestamp changes to reflect the last time you

DescribeFlowDefinition

describeFlowDefinition_flowDefinitionName :: Lens' DescribeFlowDefinition Text Source #

The name of the flow definition.

describeFlowDefinitionResponse_failureReason :: Lens' DescribeFlowDefinitionResponse (Maybe Text) Source #

The reason your flow definition failed.

describeFlowDefinitionResponse_humanLoopActivationConfig :: Lens' DescribeFlowDefinitionResponse (Maybe HumanLoopActivationConfig) Source #

An object containing information about what triggers a human review workflow.

describeFlowDefinitionResponse_humanLoopRequestSource :: Lens' DescribeFlowDefinitionResponse (Maybe HumanLoopRequestSource) Source #

Container for configuring the source of human task requests. Used to specify if Amazon Rekognition or Amazon Textract is used as an integration source.

describeFlowDefinitionResponse_httpStatus :: Lens' DescribeFlowDefinitionResponse Int Source #

The response's http status code.

describeFlowDefinitionResponse_flowDefinitionArn :: Lens' DescribeFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the flow defintion.

describeFlowDefinitionResponse_flowDefinitionName :: Lens' DescribeFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the flow definition.

describeFlowDefinitionResponse_flowDefinitionStatus :: Lens' DescribeFlowDefinitionResponse FlowDefinitionStatus Source #

The status of the flow definition. Valid values are listed below.

describeFlowDefinitionResponse_creationTime :: Lens' DescribeFlowDefinitionResponse UTCTime Source #

The timestamp when the flow definition was created.

describeFlowDefinitionResponse_humanLoopConfig :: Lens' DescribeFlowDefinitionResponse HumanLoopConfig Source #

An object containing information about who works on the task, the workforce task price, and other task details.

describeFlowDefinitionResponse_outputConfig :: Lens' DescribeFlowDefinitionResponse FlowDefinitionOutputConfig Source #

An object containing information about the output file.

describeFlowDefinitionResponse_roleArn :: Lens' DescribeFlowDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) execution role for the flow definition.

DescribeHub

describeHub_hubName :: Lens' DescribeHub Text Source #

The name of the hub to describe.

describeHubResponse_failureReason :: Lens' DescribeHubResponse (Maybe Text) Source #

The failure reason if importing hub content failed.

describeHubResponse_hubDescription :: Lens' DescribeHubResponse (Maybe Text) Source #

A description of the hub.

describeHubResponse_hubDisplayName :: Lens' DescribeHubResponse (Maybe Text) Source #

The display name of the hub.

describeHubResponse_hubSearchKeywords :: Lens' DescribeHubResponse (Maybe [Text]) Source #

The searchable keywords for the hub.

describeHubResponse_s3StorageConfig :: Lens' DescribeHubResponse (Maybe HubS3StorageConfig) Source #

The Amazon S3 storage configuration for the hub.

describeHubResponse_httpStatus :: Lens' DescribeHubResponse Int Source #

The response's http status code.

describeHubResponse_hubName :: Lens' DescribeHubResponse Text Source #

The name of the hub.

describeHubResponse_hubArn :: Lens' DescribeHubResponse Text Source #

The Amazon Resource Name (ARN) of the hub.

describeHubResponse_hubStatus :: Lens' DescribeHubResponse HubStatus Source #

The status of the hub.

describeHubResponse_creationTime :: Lens' DescribeHubResponse UTCTime Source #

The date and time that the hub was created.

describeHubResponse_lastModifiedTime :: Lens' DescribeHubResponse UTCTime Source #

The date and time that the hub was last modified.

DescribeHubContent

describeHubContent_hubContentVersion :: Lens' DescribeHubContent (Maybe Text) Source #

The version of the content to describe.

describeHubContent_hubName :: Lens' DescribeHubContent Text Source #

The name of the hub that contains the content to describe.

describeHubContent_hubContentType :: Lens' DescribeHubContent HubContentType Source #

The type of content in the hub.

describeHubContent_hubContentName :: Lens' DescribeHubContent Text Source #

The name of the content to describe.

describeHubContentResponse_failureReason :: Lens' DescribeHubContentResponse (Maybe Text) Source #

The failure reason if importing hub content failed.

describeHubContentResponse_hubContentDependencies :: Lens' DescribeHubContentResponse (Maybe [HubContentDependency]) Source #

The location of any dependencies that the hub content has, such as scripts, model artifacts, datasets, or notebooks.

describeHubContentResponse_hubContentDescription :: Lens' DescribeHubContentResponse (Maybe Text) Source #

A description of the hub content.

describeHubContentResponse_hubContentDisplayName :: Lens' DescribeHubContentResponse (Maybe Text) Source #

The display name of the hub content.

describeHubContentResponse_hubContentMarkdown :: Lens' DescribeHubContentResponse (Maybe Text) Source #

Markdown files associated with the hub content to import.

describeHubContentResponse_hubContentSearchKeywords :: Lens' DescribeHubContentResponse (Maybe [Text]) Source #

The searchable keywords for the hub content.

describeHubContentResponse_httpStatus :: Lens' DescribeHubContentResponse Int Source #

The response's http status code.

describeHubContentResponse_hubContentName :: Lens' DescribeHubContentResponse Text Source #

The name of the hub content.

describeHubContentResponse_hubContentArn :: Lens' DescribeHubContentResponse Text Source #

The Amazon Resource Name (ARN) of the hub content.

describeHubContentResponse_hubContentVersion :: Lens' DescribeHubContentResponse Text Source #

The version of the hub content.

describeHubContentResponse_hubContentType :: Lens' DescribeHubContentResponse HubContentType Source #

The type of hub content.

describeHubContentResponse_documentSchemaVersion :: Lens' DescribeHubContentResponse Text Source #

The document schema version for the hub content.

describeHubContentResponse_hubName :: Lens' DescribeHubContentResponse Text Source #

The name of the hub that contains the content.

describeHubContentResponse_hubArn :: Lens' DescribeHubContentResponse Text Source #

The Amazon Resource Name (ARN) of the hub that contains the content.

describeHubContentResponse_hubContentDocument :: Lens' DescribeHubContentResponse Text Source #

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

describeHubContentResponse_hubContentStatus :: Lens' DescribeHubContentResponse HubContentStatus Source #

The status of the hub content.

describeHubContentResponse_creationTime :: Lens' DescribeHubContentResponse UTCTime Source #

The date and time that hub content was created.

DescribeHumanTaskUi

describeHumanTaskUi_humanTaskUiName :: Lens' DescribeHumanTaskUi Text Source #

The name of the human task user interface (worker task template) you want information about.

describeHumanTaskUiResponse_humanTaskUiStatus :: Lens' DescribeHumanTaskUiResponse (Maybe HumanTaskUiStatus) Source #

The status of the human task user interface (worker task template). Valid values are listed below.

describeHumanTaskUiResponse_httpStatus :: Lens' DescribeHumanTaskUiResponse Int Source #

The response's http status code.

describeHumanTaskUiResponse_humanTaskUiArn :: Lens' DescribeHumanTaskUiResponse Text Source #

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

describeHumanTaskUiResponse_humanTaskUiName :: Lens' DescribeHumanTaskUiResponse Text Source #

The name of the human task user interface (worker task template).

describeHumanTaskUiResponse_creationTime :: Lens' DescribeHumanTaskUiResponse UTCTime Source #

The timestamp when the human task user interface was created.

describeHumanTaskUiResponse_uiTemplate :: Lens' DescribeHumanTaskUiResponse UiTemplateInfo Source #

Undocumented member.

DescribeHyperParameterTuningJob

describeHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' DescribeHyperParameterTuningJob Text Source #

The name of the tuning job.

describeHyperParameterTuningJobResponse_bestTrainingJob :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTrainingJobSummary) Source #

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

describeHyperParameterTuningJobResponse_failureReason :: Lens' DescribeHyperParameterTuningJobResponse (Maybe Text) Source #

If the tuning job failed, the reason it failed.

describeHyperParameterTuningJobResponse_hyperParameterTuningEndTime :: Lens' DescribeHyperParameterTuningJobResponse (Maybe UTCTime) Source #

The date and time that the tuning job ended.

describeHyperParameterTuningJobResponse_lastModifiedTime :: Lens' DescribeHyperParameterTuningJobResponse (Maybe UTCTime) Source #

The date and time that the status of the tuning job was modified.

describeHyperParameterTuningJobResponse_overallBestTrainingJob :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTrainingJobSummary) Source #

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

describeHyperParameterTuningJobResponse_trainingJobDefinition :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTrainingJobDefinition) Source #

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

describeHyperParameterTuningJobResponse_trainingJobDefinitions :: Lens' DescribeHyperParameterTuningJobResponse (Maybe (NonEmpty HyperParameterTrainingJobDefinition)) Source #

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

describeHyperParameterTuningJobResponse_warmStartConfig :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTuningJobWarmStartConfig) Source #

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

describeHyperParameterTuningJobResponse_httpStatus :: Lens' DescribeHyperParameterTuningJobResponse Int Source #

The response's http status code.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobName :: Lens' DescribeHyperParameterTuningJobResponse Text Source #

The name of the tuning job.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobArn :: Lens' DescribeHyperParameterTuningJobResponse Text Source #

The Amazon Resource Name (ARN) of the tuning job.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobConfig :: Lens' DescribeHyperParameterTuningJobResponse HyperParameterTuningJobConfig Source #

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobStatus :: Lens' DescribeHyperParameterTuningJobResponse HyperParameterTuningJobStatus Source #

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

describeHyperParameterTuningJobResponse_creationTime :: Lens' DescribeHyperParameterTuningJobResponse UTCTime Source #

The date and time that the tuning job started.

describeHyperParameterTuningJobResponse_trainingJobStatusCounters :: Lens' DescribeHyperParameterTuningJobResponse TrainingJobStatusCounters Source #

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

describeHyperParameterTuningJobResponse_objectiveStatusCounters :: Lens' DescribeHyperParameterTuningJobResponse ObjectiveStatusCounters Source #

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

DescribeImage

describeImage_imageName :: Lens' DescribeImage Text Source #

The name of the image to describe.

describeImageResponse_creationTime :: Lens' DescribeImageResponse (Maybe UTCTime) Source #

When the image was created.

describeImageResponse_description :: Lens' DescribeImageResponse (Maybe Text) Source #

The description of the image.

describeImageResponse_displayName :: Lens' DescribeImageResponse (Maybe Text) Source #

The name of the image as displayed.

describeImageResponse_failureReason :: Lens' DescribeImageResponse (Maybe Text) Source #

When a create, update, or delete operation fails, the reason for the failure.

describeImageResponse_imageArn :: Lens' DescribeImageResponse (Maybe Text) Source #

The ARN of the image.

describeImageResponse_imageName :: Lens' DescribeImageResponse (Maybe Text) Source #

The name of the image.

describeImageResponse_imageStatus :: Lens' DescribeImageResponse (Maybe ImageStatus) Source #

The status of the image.

describeImageResponse_lastModifiedTime :: Lens' DescribeImageResponse (Maybe UTCTime) Source #

When the image was last modified.

describeImageResponse_roleArn :: Lens' DescribeImageResponse (Maybe Text) Source #

The ARN of the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

describeImageResponse_httpStatus :: Lens' DescribeImageResponse Int Source #

The response's http status code.

DescribeImageVersion

describeImageVersion_alias :: Lens' DescribeImageVersion (Maybe Text) Source #

The alias of the image version.

describeImageVersion_version :: Lens' DescribeImageVersion (Maybe Natural) Source #

The version of the image. If not specified, the latest version is described.

describeImageVersion_imageName :: Lens' DescribeImageVersion Text Source #

The name of the image.

describeImageVersionResponse_baseImage :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The registry path of the container image on which this image version is based.

describeImageVersionResponse_containerImage :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The registry path of the container image that contains this image version.

describeImageVersionResponse_creationTime :: Lens' DescribeImageVersionResponse (Maybe UTCTime) Source #

When the version was created.

describeImageVersionResponse_failureReason :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

When a create or delete operation fails, the reason for the failure.

describeImageVersionResponse_horovod :: Lens' DescribeImageVersionResponse (Maybe Bool) Source #

Indicates Horovod compatibility.

describeImageVersionResponse_imageArn :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The ARN of the image the version is based on.

describeImageVersionResponse_imageVersionArn :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The ARN of the version.

describeImageVersionResponse_imageVersionStatus :: Lens' DescribeImageVersionResponse (Maybe ImageVersionStatus) Source #

The status of the version.

describeImageVersionResponse_jobType :: Lens' DescribeImageVersionResponse (Maybe JobType) Source #

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.
  • INFERENCE: The image version is compatible with SageMaker inference jobs.
  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

describeImageVersionResponse_lastModifiedTime :: Lens' DescribeImageVersionResponse (Maybe UTCTime) Source #

When the version was last modified.

describeImageVersionResponse_mLFramework :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The machine learning framework vended in the image version.

describeImageVersionResponse_processor :: Lens' DescribeImageVersionResponse (Maybe Processor) Source #

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.
  • GPU: The image version is compatible with GPU.

describeImageVersionResponse_programmingLang :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The supported programming language and its version.

describeImageVersionResponse_releaseNotes :: Lens' DescribeImageVersionResponse (Maybe Text) Source #

The maintainer description of the image version.

describeImageVersionResponse_vendorGuidance :: Lens' DescribeImageVersionResponse (Maybe VendorGuidance) Source #

The stability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.
  • STABLE: The image version is stable.
  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

describeImageVersionResponse_version :: Lens' DescribeImageVersionResponse (Maybe Natural) Source #

The version number.

describeImageVersionResponse_httpStatus :: Lens' DescribeImageVersionResponse Int Source #

The response's http status code.

DescribeInferenceExperiment

describeInferenceExperiment_name :: Lens' DescribeInferenceExperiment Text Source #

The name of the inference experiment to describe.

describeInferenceExperimentResponse_completionTime :: Lens' DescribeInferenceExperimentResponse (Maybe UTCTime) Source #

The timestamp at which the inference experiment was completed.

describeInferenceExperimentResponse_creationTime :: Lens' DescribeInferenceExperimentResponse (Maybe UTCTime) Source #

The timestamp at which you created the inference experiment.

describeInferenceExperimentResponse_dataStorageConfig :: Lens' DescribeInferenceExperimentResponse (Maybe InferenceExperimentDataStorageConfig) Source #

The Amazon S3 location and configuration for storing inference request and response data.

describeInferenceExperimentResponse_description :: Lens' DescribeInferenceExperimentResponse (Maybe Text) Source #

The description of the inference experiment.

describeInferenceExperimentResponse_kmsKey :: Lens' DescribeInferenceExperimentResponse (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperimentRequest$KmsKey.

describeInferenceExperimentResponse_lastModifiedTime :: Lens' DescribeInferenceExperimentResponse (Maybe UTCTime) Source #

The timestamp at which you last modified the inference experiment.

describeInferenceExperimentResponse_roleArn :: Lens' DescribeInferenceExperimentResponse (Maybe Text) Source #

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.

describeInferenceExperimentResponse_schedule :: Lens' DescribeInferenceExperimentResponse (Maybe InferenceExperimentSchedule) Source #

The duration for which the inference experiment ran or will run.

describeInferenceExperimentResponse_shadowModeConfig :: Lens' DescribeInferenceExperimentResponse (Maybe ShadowModeConfig) Source #

The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

describeInferenceExperimentResponse_statusReason :: Lens' DescribeInferenceExperimentResponse (Maybe Text) Source #

The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

describeInferenceExperimentResponse_httpStatus :: Lens' DescribeInferenceExperimentResponse Int Source #

The response's http status code.

describeInferenceExperimentResponse_arn :: Lens' DescribeInferenceExperimentResponse Text Source #

The ARN of the inference experiment being described.

describeInferenceExperimentResponse_name :: Lens' DescribeInferenceExperimentResponse Text Source #

The name of the inference experiment.

describeInferenceExperimentResponse_type :: Lens' DescribeInferenceExperimentResponse InferenceExperimentType Source #

The type of the inference experiment.

describeInferenceExperimentResponse_status :: Lens' DescribeInferenceExperimentResponse InferenceExperimentStatus Source #

The status of the inference experiment. The following are the possible statuses for an inference experiment:

  • Creating - Amazon SageMaker is creating your experiment.
  • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.
  • Updating - When you make changes to your experiment, your experiment shows as updating.
  • Starting - Amazon SageMaker is beginning your experiment.
  • Running - Your experiment is in progress.
  • Stopping - Amazon SageMaker is stopping your experiment.
  • Completed - Your experiment has completed.
  • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

describeInferenceExperimentResponse_endpointMetadata :: Lens' DescribeInferenceExperimentResponse EndpointMetadata Source #

The metadata of the endpoint on which the inference experiment ran.

describeInferenceExperimentResponse_modelVariants :: Lens' DescribeInferenceExperimentResponse [ModelVariantConfigSummary] Source #

An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

DescribeInferenceRecommendationsJob

describeInferenceRecommendationsJob_jobName :: Lens' DescribeInferenceRecommendationsJob Text Source #

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeInferenceRecommendationsJobResponse_completionTime :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe UTCTime) Source #

A timestamp that shows when the job completed.

describeInferenceRecommendationsJobResponse_endpointPerformances :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe [EndpointPerformance]) Source #

The performance results from running an Inference Recommender job on an existing endpoint.

describeInferenceRecommendationsJobResponse_failureReason :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe Text) Source #

If the job fails, provides information why the job failed.

describeInferenceRecommendationsJobResponse_inferenceRecommendations :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe (NonEmpty InferenceRecommendation)) Source #

The recommendations made by Inference Recommender.

describeInferenceRecommendationsJobResponse_jobDescription :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe Text) Source #

The job description that you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_stoppingConditions :: Lens' DescribeInferenceRecommendationsJobResponse (Maybe RecommendationJobStoppingConditions) Source #

The stopping conditions that you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_httpStatus :: Lens' DescribeInferenceRecommendationsJobResponse Int Source #

The response's http status code.

describeInferenceRecommendationsJobResponse_jobName :: Lens' DescribeInferenceRecommendationsJobResponse Text Source #

The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeInferenceRecommendationsJobResponse_jobType :: Lens' DescribeInferenceRecommendationsJobResponse RecommendationJobType Source #

The job type that you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_jobArn :: Lens' DescribeInferenceRecommendationsJobResponse Text Source #

The Amazon Resource Name (ARN) of the job.

describeInferenceRecommendationsJobResponse_roleArn :: Lens' DescribeInferenceRecommendationsJobResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.

describeInferenceRecommendationsJobResponse_status :: Lens' DescribeInferenceRecommendationsJobResponse RecommendationJobStatus Source #

The status of the job.

describeInferenceRecommendationsJobResponse_creationTime :: Lens' DescribeInferenceRecommendationsJobResponse UTCTime Source #

A timestamp that shows when the job was created.

describeInferenceRecommendationsJobResponse_lastModifiedTime :: Lens' DescribeInferenceRecommendationsJobResponse UTCTime Source #

A timestamp that shows when the job was last modified.

describeInferenceRecommendationsJobResponse_inputConfig :: Lens' DescribeInferenceRecommendationsJobResponse RecommendationJobInputConfig Source #

Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.

DescribeLabelingJob

describeLabelingJob_labelingJobName :: Lens' DescribeLabelingJob Text Source #

The name of the labeling job to return information for.

describeLabelingJobResponse_failureReason :: Lens' DescribeLabelingJobResponse (Maybe Text) Source #

If the job failed, the reason that it failed.

describeLabelingJobResponse_labelAttributeName :: Lens' DescribeLabelingJobResponse (Maybe Text) Source #

The attribute used as the label in the output manifest file.

describeLabelingJobResponse_labelCategoryConfigS3Uri :: Lens' DescribeLabelingJobResponse (Maybe Text) Source #

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels
  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{
 "document-version": "2018-11-28"
 "labels": [
 {

"label": "label 1"

 },
 {

"label": "label 2"

 },
 ...
 {

"label": "label n"

 }
 ]
}

describeLabelingJobResponse_labelingJobAlgorithmsConfig :: Lens' DescribeLabelingJobResponse (Maybe LabelingJobAlgorithmsConfig) Source #

Configuration information for automated data labeling.

describeLabelingJobResponse_labelingJobOutput :: Lens' DescribeLabelingJobResponse (Maybe LabelingJobOutput) Source #

The location of the output produced by the labeling job.

describeLabelingJobResponse_stoppingConditions :: Lens' DescribeLabelingJobResponse (Maybe LabelingJobStoppingConditions) Source #

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

describeLabelingJobResponse_tags :: Lens' DescribeLabelingJobResponse (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

describeLabelingJobResponse_httpStatus :: Lens' DescribeLabelingJobResponse Int Source #

The response's http status code.

describeLabelingJobResponse_labelingJobStatus :: Lens' DescribeLabelingJobResponse LabelingJobStatus Source #

The processing status of the labeling job.

describeLabelingJobResponse_labelCounters :: Lens' DescribeLabelingJobResponse LabelCounters Source #

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

describeLabelingJobResponse_creationTime :: Lens' DescribeLabelingJobResponse UTCTime Source #

The date and time that the labeling job was created.

describeLabelingJobResponse_lastModifiedTime :: Lens' DescribeLabelingJobResponse UTCTime Source #

The date and time that the labeling job was last updated.

describeLabelingJobResponse_jobReferenceCode :: Lens' DescribeLabelingJobResponse Text Source #

A unique identifier for work done as part of a labeling job.

describeLabelingJobResponse_labelingJobName :: Lens' DescribeLabelingJobResponse Text Source #

The name assigned to the labeling job when it was created.

describeLabelingJobResponse_labelingJobArn :: Lens' DescribeLabelingJobResponse Text Source #

The Amazon Resource Name (ARN) of the labeling job.

describeLabelingJobResponse_inputConfig :: Lens' DescribeLabelingJobResponse LabelingJobInputConfig Source #

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

describeLabelingJobResponse_outputConfig :: Lens' DescribeLabelingJobResponse LabelingJobOutputConfig Source #

The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

describeLabelingJobResponse_roleArn :: Lens' DescribeLabelingJobResponse Text Source #

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

describeLabelingJobResponse_humanTaskConfig :: Lens' DescribeLabelingJobResponse HumanTaskConfig Source #

Configuration information required for human workers to complete a labeling task.

DescribeLineageGroup

describeLineageGroup_lineageGroupName :: Lens' DescribeLineageGroup Text Source #

The name of the lineage group.

describeLineageGroupResponse_createdBy :: Lens' DescribeLineageGroupResponse (Maybe UserContext) Source #

Undocumented member.

describeLineageGroupResponse_creationTime :: Lens' DescribeLineageGroupResponse (Maybe UTCTime) Source #

The creation time of lineage group.

describeLineageGroupResponse_description :: Lens' DescribeLineageGroupResponse (Maybe Text) Source #

The description of the lineage group.

describeLineageGroupResponse_displayName :: Lens' DescribeLineageGroupResponse (Maybe Text) Source #

The display name of the lineage group.

describeLineageGroupResponse_lastModifiedBy :: Lens' DescribeLineageGroupResponse (Maybe UserContext) Source #

Undocumented member.

describeLineageGroupResponse_lastModifiedTime :: Lens' DescribeLineageGroupResponse (Maybe UTCTime) Source #

The last modified time of the lineage group.

describeLineageGroupResponse_lineageGroupArn :: Lens' DescribeLineageGroupResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group.

describeLineageGroupResponse_lineageGroupName :: Lens' DescribeLineageGroupResponse (Maybe Text) Source #

The name of the lineage group.

describeLineageGroupResponse_httpStatus :: Lens' DescribeLineageGroupResponse Int Source #

The response's http status code.

DescribeModel

describeModel_modelName :: Lens' DescribeModel Text Source #

The name of the model.

describeModelResponse_containers :: Lens' DescribeModelResponse (Maybe [ContainerDefinition]) Source #

The containers in the inference pipeline.

describeModelResponse_enableNetworkIsolation :: Lens' DescribeModelResponse (Maybe Bool) Source #

If True, no inbound or outbound network calls can be made to or from the model container.

describeModelResponse_inferenceExecutionConfig :: Lens' DescribeModelResponse (Maybe InferenceExecutionConfig) Source #

Specifies details of how containers in a multi-container endpoint are called.

describeModelResponse_primaryContainer :: Lens' DescribeModelResponse (Maybe ContainerDefinition) Source #

The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

describeModelResponse_vpcConfig :: Lens' DescribeModelResponse (Maybe VpcConfig) Source #

A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

describeModelResponse_httpStatus :: Lens' DescribeModelResponse Int Source #

The response's http status code.

describeModelResponse_modelName :: Lens' DescribeModelResponse Text Source #

Name of the SageMaker model.

describeModelResponse_executionRoleArn :: Lens' DescribeModelResponse Text Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

describeModelResponse_creationTime :: Lens' DescribeModelResponse UTCTime Source #

A timestamp that shows when the model was created.

describeModelResponse_modelArn :: Lens' DescribeModelResponse Text Source #

The Amazon Resource Name (ARN) of the model.

DescribeModelBiasJobDefinition

describeModelBiasJobDefinition_jobDefinitionName :: Lens' DescribeModelBiasJobDefinition Text Source #

The name of the model bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeModelBiasJobDefinitionResponse_modelBiasBaselineConfig :: Lens' DescribeModelBiasJobDefinitionResponse (Maybe ModelBiasBaselineConfig) Source #

The baseline configuration for a model bias job.

describeModelBiasJobDefinitionResponse_networkConfig :: Lens' DescribeModelBiasJobDefinitionResponse (Maybe MonitoringNetworkConfig) Source #

Networking options for a model bias job.

describeModelBiasJobDefinitionResponse_stoppingCondition :: Lens' DescribeModelBiasJobDefinitionResponse (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

describeModelBiasJobDefinitionResponse_httpStatus :: Lens' DescribeModelBiasJobDefinitionResponse Int Source #

The response's http status code.

describeModelBiasJobDefinitionResponse_jobDefinitionArn :: Lens' DescribeModelBiasJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model bias job.

describeModelBiasJobDefinitionResponse_jobDefinitionName :: Lens' DescribeModelBiasJobDefinitionResponse Text Source #

The name of the bias job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeModelBiasJobDefinitionResponse_creationTime :: Lens' DescribeModelBiasJobDefinitionResponse UTCTime Source #

The time at which the model bias job was created.

describeModelBiasJobDefinitionResponse_modelBiasAppSpecification :: Lens' DescribeModelBiasJobDefinitionResponse ModelBiasAppSpecification Source #

Configures the model bias job to run a specified Docker container image.

describeModelBiasJobDefinitionResponse_modelBiasJobInput :: Lens' DescribeModelBiasJobDefinitionResponse ModelBiasJobInput Source #

Inputs for the model bias job.

describeModelBiasJobDefinitionResponse_modelBiasJobOutputConfig :: Lens' DescribeModelBiasJobDefinitionResponse MonitoringOutputConfig Source #

Undocumented member.

describeModelBiasJobDefinitionResponse_jobResources :: Lens' DescribeModelBiasJobDefinitionResponse MonitoringResources Source #

Undocumented member.

describeModelBiasJobDefinitionResponse_roleArn :: Lens' DescribeModelBiasJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

DescribeModelCard

describeModelCard_modelCardVersion :: Lens' DescribeModelCard (Maybe Int) Source #

The version of the model card to describe. If a version is not provided, then the latest version of the model card is described.

describeModelCard_modelCardName :: Lens' DescribeModelCard Text Source #

The name of the model card to describe.

describeModelCardResponse_lastModifiedBy :: Lens' DescribeModelCardResponse (Maybe UserContext) Source #

Undocumented member.

describeModelCardResponse_lastModifiedTime :: Lens' DescribeModelCardResponse (Maybe UTCTime) Source #

The date and time the model card was last modified.

describeModelCardResponse_modelCardProcessingStatus :: Lens' DescribeModelCardResponse (Maybe ModelCardProcessingStatus) Source #

The processing status of model card deletion. The ModelCardProcessingStatus updates throughout the different deletion steps.

  • DeletePending: Model card deletion request received.
  • DeleteInProgress: Model card deletion is in progress.
  • ContentDeleted: Deleted model card content.
  • ExportJobsDeleted: Deleted all export jobs associated with the model card.
  • DeleteCompleted: Successfully deleted the model card.
  • DeleteFailed: The model card failed to delete.

describeModelCardResponse_securityConfig :: Lens' DescribeModelCardResponse (Maybe ModelCardSecurityConfig) Source #

The security configuration used to protect model card content.

describeModelCardResponse_httpStatus :: Lens' DescribeModelCardResponse Int Source #

The response's http status code.

describeModelCardResponse_modelCardArn :: Lens' DescribeModelCardResponse Text Source #

The Amazon Resource Name (ARN) of the model card.

describeModelCardResponse_modelCardName :: Lens' DescribeModelCardResponse Text Source #

The name of the model card.

describeModelCardResponse_modelCardVersion :: Lens' DescribeModelCardResponse Int Source #

The version of the model card.

describeModelCardResponse_content :: Lens' DescribeModelCardResponse Text Source #

The content of the model card.

describeModelCardResponse_modelCardStatus :: Lens' DescribeModelCardResponse ModelCardStatus Source #

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.

describeModelCardResponse_creationTime :: Lens' DescribeModelCardResponse UTCTime Source #

The date and time the model card was created.

describeModelCardResponse_createdBy :: Lens' DescribeModelCardResponse UserContext Source #

Undocumented member.

DescribeModelCardExportJob

describeModelCardExportJob_modelCardExportJobArn :: Lens' DescribeModelCardExportJob Text Source #

The Amazon Resource Name (ARN) of the model card export job to describe.

describeModelCardExportJobResponse_exportArtifacts :: Lens' DescribeModelCardExportJobResponse (Maybe ModelCardExportArtifacts) Source #

The exported model card artifacts.

describeModelCardExportJobResponse_failureReason :: Lens' DescribeModelCardExportJobResponse (Maybe Text) Source #

The failure reason if the model export job fails.

describeModelCardExportJobResponse_httpStatus :: Lens' DescribeModelCardExportJobResponse Int Source #

The response's http status code.

describeModelCardExportJobResponse_modelCardExportJobName :: Lens' DescribeModelCardExportJobResponse Text Source #

The name of the model card export job to describe.

describeModelCardExportJobResponse_modelCardExportJobArn :: Lens' DescribeModelCardExportJobResponse Text Source #

The Amazon Resource Name (ARN) of the model card export job.

describeModelCardExportJobResponse_status :: Lens' DescribeModelCardExportJobResponse ModelCardExportJobStatus Source #

The completion status of the model card export job.

  • InProgress: The model card export job is in progress.
  • Completed: The model card export job is complete.
  • Failed: The model card export job failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeModelCardExportJob call.

describeModelCardExportJobResponse_modelCardName :: Lens' DescribeModelCardExportJobResponse Text Source #

The name of the model card that the model export job exports.

describeModelCardExportJobResponse_modelCardVersion :: Lens' DescribeModelCardExportJobResponse Int Source #

The version of the model card that the model export job exports.

describeModelCardExportJobResponse_outputConfig :: Lens' DescribeModelCardExportJobResponse ModelCardExportOutputConfig Source #

The export output details for the model card.

describeModelCardExportJobResponse_createdAt :: Lens' DescribeModelCardExportJobResponse UTCTime Source #

The date and time that the model export job was created.

describeModelCardExportJobResponse_lastModifiedAt :: Lens' DescribeModelCardExportJobResponse UTCTime Source #

The date and time that the model export job was last modified.

DescribeModelExplainabilityJobDefinition

describeModelExplainabilityJobDefinition_jobDefinitionName :: Lens' DescribeModelExplainabilityJobDefinition Text Source #

The name of the model explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityBaselineConfig :: Lens' DescribeModelExplainabilityJobDefinitionResponse (Maybe ModelExplainabilityBaselineConfig) Source #

The baseline configuration for a model explainability job.

describeModelExplainabilityJobDefinitionResponse_networkConfig :: Lens' DescribeModelExplainabilityJobDefinitionResponse (Maybe MonitoringNetworkConfig) Source #

Networking options for a model explainability job.

describeModelExplainabilityJobDefinitionResponse_stoppingCondition :: Lens' DescribeModelExplainabilityJobDefinitionResponse (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

describeModelExplainabilityJobDefinitionResponse_httpStatus :: Lens' DescribeModelExplainabilityJobDefinitionResponse Int Source #

The response's http status code.

describeModelExplainabilityJobDefinitionResponse_jobDefinitionArn :: Lens' DescribeModelExplainabilityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model explainability job.

describeModelExplainabilityJobDefinitionResponse_jobDefinitionName :: Lens' DescribeModelExplainabilityJobDefinitionResponse Text Source #

The name of the explainability job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeModelExplainabilityJobDefinitionResponse_creationTime :: Lens' DescribeModelExplainabilityJobDefinitionResponse UTCTime Source #

The time at which the model explainability job was created.

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityAppSpecification :: Lens' DescribeModelExplainabilityJobDefinitionResponse ModelExplainabilityAppSpecification Source #

Configures the model explainability job to run a specified Docker container image.

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityJobInput :: Lens' DescribeModelExplainabilityJobDefinitionResponse ModelExplainabilityJobInput Source #

Inputs for the model explainability job.

describeModelExplainabilityJobDefinitionResponse_modelExplainabilityJobOutputConfig :: Lens' DescribeModelExplainabilityJobDefinitionResponse MonitoringOutputConfig Source #

Undocumented member.

describeModelExplainabilityJobDefinitionResponse_jobResources :: Lens' DescribeModelExplainabilityJobDefinitionResponse MonitoringResources Source #

Undocumented member.

describeModelExplainabilityJobDefinitionResponse_roleArn :: Lens' DescribeModelExplainabilityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that has read permission to the input data location and write permission to the output data location in Amazon S3.

DescribeModelPackage

describeModelPackage_modelPackageName :: Lens' DescribeModelPackage Text Source #

The name or Amazon Resource Name (ARN) of the model package to describe.

When you specify a name, the name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

describeModelPackageResponse_additionalInferenceSpecifications :: Lens' DescribeModelPackageResponse (Maybe (NonEmpty AdditionalInferenceSpecificationDefinition)) Source #

An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

describeModelPackageResponse_approvalDescription :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

A description provided for the model approval.

describeModelPackageResponse_certifyForMarketplace :: Lens' DescribeModelPackageResponse (Maybe Bool) Source #

Whether the model package is certified for listing on Amazon Web Services Marketplace.

describeModelPackageResponse_createdBy :: Lens' DescribeModelPackageResponse (Maybe UserContext) Source #

Undocumented member.

describeModelPackageResponse_customerMetadataProperties :: Lens' DescribeModelPackageResponse (Maybe (HashMap Text Text)) Source #

The metadata properties associated with the model package versions.

describeModelPackageResponse_domain :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

The machine learning domain of the model package you specified. Common machine learning domains include computer vision and natural language processing.

describeModelPackageResponse_driftCheckBaselines :: Lens' DescribeModelPackageResponse (Maybe DriftCheckBaselines) Source #

Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.

describeModelPackageResponse_inferenceSpecification :: Lens' DescribeModelPackageResponse (Maybe InferenceSpecification) Source #

Details about inference jobs that can be run with models based on this model package.

describeModelPackageResponse_lastModifiedBy :: Lens' DescribeModelPackageResponse (Maybe UserContext) Source #

Undocumented member.

describeModelPackageResponse_lastModifiedTime :: Lens' DescribeModelPackageResponse (Maybe UTCTime) Source #

The last time that the model package was modified.

describeModelPackageResponse_metadataProperties :: Lens' DescribeModelPackageResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeModelPackageResponse_modelApprovalStatus :: Lens' DescribeModelPackageResponse (Maybe ModelApprovalStatus) Source #

The approval status of the model package.

describeModelPackageResponse_modelMetrics :: Lens' DescribeModelPackageResponse (Maybe ModelMetrics) Source #

Metrics for the model.

describeModelPackageResponse_modelPackageDescription :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

A brief summary of the model package.

describeModelPackageResponse_modelPackageGroupName :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

If the model is a versioned model, the name of the model group that the versioned model belongs to.

describeModelPackageResponse_modelPackageVersion :: Lens' DescribeModelPackageResponse (Maybe Natural) Source #

The version of the model package.

describeModelPackageResponse_samplePayloadUrl :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path points to a single gzip compressed tar archive (.tar.gz suffix).

describeModelPackageResponse_sourceAlgorithmSpecification :: Lens' DescribeModelPackageResponse (Maybe SourceAlgorithmSpecification) Source #

Details about the algorithm that was used to create the model package.

describeModelPackageResponse_task :: Lens' DescribeModelPackageResponse (Maybe Text) Source #

The machine learning task you specified that your model package accomplishes. Common machine learning tasks include object detection and image classification.

describeModelPackageResponse_validationSpecification :: Lens' DescribeModelPackageResponse (Maybe ModelPackageValidationSpecification) Source #

Configurations for one or more transform jobs that SageMaker runs to test the model package.

describeModelPackageResponse_httpStatus :: Lens' DescribeModelPackageResponse Int Source #

The response's http status code.

describeModelPackageResponse_modelPackageName :: Lens' DescribeModelPackageResponse Text Source #

The name of the model package being described.

describeModelPackageResponse_modelPackageArn :: Lens' DescribeModelPackageResponse Text Source #

The Amazon Resource Name (ARN) of the model package.

describeModelPackageResponse_creationTime :: Lens' DescribeModelPackageResponse UTCTime Source #

A timestamp specifying when the model package was created.

describeModelPackageResponse_modelPackageStatus :: Lens' DescribeModelPackageResponse ModelPackageStatus Source #

The current status of the model package.

describeModelPackageResponse_modelPackageStatusDetails :: Lens' DescribeModelPackageResponse ModelPackageStatusDetails Source #

Details about the current status of the model package.

DescribeModelPackageGroup

describeModelPackageGroup_modelPackageGroupName :: Lens' DescribeModelPackageGroup Text Source #

The name of gthe model group to describe.

describeModelPackageGroupResponse_modelPackageGroupDescription :: Lens' DescribeModelPackageGroupResponse (Maybe Text) Source #

A description of the model group.

describeModelPackageGroupResponse_httpStatus :: Lens' DescribeModelPackageGroupResponse Int Source #

The response's http status code.

describeModelPackageGroupResponse_modelPackageGroupName :: Lens' DescribeModelPackageGroupResponse Text Source #

The name of the model group.

describeModelPackageGroupResponse_modelPackageGroupArn :: Lens' DescribeModelPackageGroupResponse Text Source #

The Amazon Resource Name (ARN) of the model group.

describeModelPackageGroupResponse_creationTime :: Lens' DescribeModelPackageGroupResponse UTCTime Source #

The time that the model group was created.

describeModelPackageGroupResponse_createdBy :: Lens' DescribeModelPackageGroupResponse UserContext Source #

Undocumented member.

describeModelPackageGroupResponse_modelPackageGroupStatus :: Lens' DescribeModelPackageGroupResponse ModelPackageGroupStatus Source #

The status of the model group.

DescribeModelQualityJobDefinition

describeModelQualityJobDefinition_jobDefinitionName :: Lens' DescribeModelQualityJobDefinition Text Source #

The name of the model quality job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeModelQualityJobDefinitionResponse_modelQualityBaselineConfig :: Lens' DescribeModelQualityJobDefinitionResponse (Maybe ModelQualityBaselineConfig) Source #

The baseline configuration for a model quality job.

describeModelQualityJobDefinitionResponse_networkConfig :: Lens' DescribeModelQualityJobDefinitionResponse (Maybe MonitoringNetworkConfig) Source #

Networking options for a model quality job.

describeModelQualityJobDefinitionResponse_stoppingCondition :: Lens' DescribeModelQualityJobDefinitionResponse (Maybe MonitoringStoppingCondition) Source #

Undocumented member.

describeModelQualityJobDefinitionResponse_httpStatus :: Lens' DescribeModelQualityJobDefinitionResponse Int Source #

The response's http status code.

describeModelQualityJobDefinitionResponse_jobDefinitionArn :: Lens' DescribeModelQualityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the model quality job.

describeModelQualityJobDefinitionResponse_jobDefinitionName :: Lens' DescribeModelQualityJobDefinitionResponse Text Source #

The name of the quality job definition. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeModelQualityJobDefinitionResponse_creationTime :: Lens' DescribeModelQualityJobDefinitionResponse UTCTime Source #

The time at which the model quality job was created.

describeModelQualityJobDefinitionResponse_modelQualityAppSpecification :: Lens' DescribeModelQualityJobDefinitionResponse ModelQualityAppSpecification Source #

Configures the model quality job to run a specified Docker container image.

describeModelQualityJobDefinitionResponse_modelQualityJobInput :: Lens' DescribeModelQualityJobDefinitionResponse ModelQualityJobInput Source #

Inputs for the model quality job.

describeModelQualityJobDefinitionResponse_modelQualityJobOutputConfig :: Lens' DescribeModelQualityJobDefinitionResponse MonitoringOutputConfig Source #

Undocumented member.

describeModelQualityJobDefinitionResponse_jobResources :: Lens' DescribeModelQualityJobDefinitionResponse MonitoringResources Source #

Undocumented member.

describeModelQualityJobDefinitionResponse_roleArn :: Lens' DescribeModelQualityJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

DescribeMonitoringSchedule

describeMonitoringSchedule_monitoringScheduleName :: Lens' DescribeMonitoringSchedule Text Source #

Name of a previously created monitoring schedule.

describeMonitoringScheduleResponse_endpointName :: Lens' DescribeMonitoringScheduleResponse (Maybe Text) Source #

The name of the endpoint for the monitoring job.

describeMonitoringScheduleResponse_failureReason :: Lens' DescribeMonitoringScheduleResponse (Maybe Text) Source #

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

describeMonitoringScheduleResponse_lastMonitoringExecutionSummary :: Lens' DescribeMonitoringScheduleResponse (Maybe MonitoringExecutionSummary) Source #

Describes metadata on the last execution to run, if there was one.

describeMonitoringScheduleResponse_monitoringType :: Lens' DescribeMonitoringScheduleResponse (Maybe MonitoringType) Source #

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.
  • MODEL_QUALITY - The schedule is for a model quality monitoring job.
  • MODEL_BIAS - The schedule is for a bias monitoring job.
  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.

describeMonitoringScheduleResponse_httpStatus :: Lens' DescribeMonitoringScheduleResponse Int Source #

The response's http status code.

describeMonitoringScheduleResponse_monitoringScheduleArn :: Lens' DescribeMonitoringScheduleResponse Text Source #

The Amazon Resource Name (ARN) of the monitoring schedule.

describeMonitoringScheduleResponse_monitoringScheduleName :: Lens' DescribeMonitoringScheduleResponse Text Source #

Name of the monitoring schedule.

describeMonitoringScheduleResponse_monitoringScheduleStatus :: Lens' DescribeMonitoringScheduleResponse ScheduleStatus Source #

The status of an monitoring job.

describeMonitoringScheduleResponse_creationTime :: Lens' DescribeMonitoringScheduleResponse UTCTime Source #

The time at which the monitoring job was created.

describeMonitoringScheduleResponse_lastModifiedTime :: Lens' DescribeMonitoringScheduleResponse UTCTime Source #

The time at which the monitoring job was last modified.

describeMonitoringScheduleResponse_monitoringScheduleConfig :: Lens' DescribeMonitoringScheduleResponse MonitoringScheduleConfig Source #

The configuration object that specifies the monitoring schedule and defines the monitoring job.

DescribeNotebookInstance

describeNotebookInstance_notebookInstanceName :: Lens' DescribeNotebookInstance Text Source #

The name of the notebook instance that you want information about.

describeNotebookInstanceResponse_acceleratorTypes :: Lens' DescribeNotebookInstanceResponse (Maybe [NotebookInstanceAcceleratorType]) Source #

A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

describeNotebookInstanceResponse_additionalCodeRepositories :: Lens' DescribeNotebookInstanceResponse (Maybe [Text]) Source #

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 Notebook Instances.

describeNotebookInstanceResponse_creationTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime) Source #

A timestamp. Use this parameter to return the time when the notebook instance was created

describeNotebookInstanceResponse_defaultCodeRepository :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

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 Notebook Instances.

describeNotebookInstanceResponse_directInternetAccess :: Lens' DescribeNotebookInstanceResponse (Maybe DirectInternetAccess) Source #

Describes whether SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to SageMaker training and endpoint services.

For more information, see Notebook Instances Are Internet-Enabled by Default.

describeNotebookInstanceResponse_failureReason :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

If status is Failed, the reason it failed.

describeNotebookInstanceResponse_instanceMetadataServiceConfiguration :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceMetadataServiceConfiguration) Source #

Information on the IMDS configuration of the notebook instance

describeNotebookInstanceResponse_instanceType :: Lens' DescribeNotebookInstanceResponse (Maybe InstanceType) Source #

The type of ML compute instance running on the notebook instance.

describeNotebookInstanceResponse_kmsKeyId :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The Amazon Web Services KMS key ID SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

describeNotebookInstanceResponse_lastModifiedTime :: Lens' DescribeNotebookInstanceResponse (Maybe UTCTime) Source #

A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

describeNotebookInstanceResponse_networkInterfaceId :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The network interface IDs that SageMaker created at the time of creating the instance.

describeNotebookInstanceResponse_notebookInstanceArn :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the notebook instance.

describeNotebookInstanceResponse_notebookInstanceLifecycleConfigName :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

Returns the name of a notebook instance lifecycle configuration.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

describeNotebookInstanceResponse_notebookInstanceName :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The name of the SageMaker notebook instance.

describeNotebookInstanceResponse_notebookInstanceStatus :: Lens' DescribeNotebookInstanceResponse (Maybe NotebookInstanceStatus) Source #

The status of the notebook instance.

describeNotebookInstanceResponse_platformIdentifier :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The platform identifier of the notebook instance runtime environment.

describeNotebookInstanceResponse_roleArn :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role associated with the instance.

describeNotebookInstanceResponse_rootAccess :: Lens' DescribeNotebookInstanceResponse (Maybe RootAccess) Source #

Whether root access is enabled or disabled for users of the notebook instance.

Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

describeNotebookInstanceResponse_securityGroups :: Lens' DescribeNotebookInstanceResponse (Maybe [Text]) Source #

The IDs of the VPC security groups.

describeNotebookInstanceResponse_subnetId :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The ID of the VPC subnet.

describeNotebookInstanceResponse_url :: Lens' DescribeNotebookInstanceResponse (Maybe Text) Source #

The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

describeNotebookInstanceResponse_volumeSizeInGB :: Lens' DescribeNotebookInstanceResponse (Maybe Natural) Source #

The size, in GB, of the ML storage volume attached to the notebook instance.

describeNotebookInstanceResponse_httpStatus :: Lens' DescribeNotebookInstanceResponse Int Source #

The response's http status code.

DescribeNotebookInstanceLifecycleConfig

describeNotebookInstanceLifecycleConfig_notebookInstanceLifecycleConfigName :: Lens' DescribeNotebookInstanceLifecycleConfig Text Source #

The name of the lifecycle configuration to describe.

describeNotebookInstanceLifecycleConfigResponse_creationTime :: Lens' DescribeNotebookInstanceLifecycleConfigResponse (Maybe UTCTime) Source #

A timestamp that tells when the lifecycle configuration was created.

describeNotebookInstanceLifecycleConfigResponse_lastModifiedTime :: Lens' DescribeNotebookInstanceLifecycleConfigResponse (Maybe UTCTime) Source #

A timestamp that tells when the lifecycle configuration was last modified.

describeNotebookInstanceLifecycleConfigResponse_notebookInstanceLifecycleConfigArn :: Lens' DescribeNotebookInstanceLifecycleConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lifecycle configuration.

describeNotebookInstanceLifecycleConfigResponse_notebookInstanceLifecycleConfigName :: Lens' DescribeNotebookInstanceLifecycleConfigResponse (Maybe Text) Source #

The name of the lifecycle configuration.

describeNotebookInstanceLifecycleConfigResponse_onCreate :: Lens' DescribeNotebookInstanceLifecycleConfigResponse (Maybe [NotebookInstanceLifecycleHook]) Source #

The shell script that runs only once, when you create a notebook instance.

describeNotebookInstanceLifecycleConfigResponse_onStart :: Lens' DescribeNotebookInstanceLifecycleConfigResponse (Maybe [NotebookInstanceLifecycleHook]) Source #

The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

describeNotebookInstanceLifecycleConfigResponse_httpStatus :: Lens' DescribeNotebookInstanceLifecycleConfigResponse Int Source #

The response's http status code.

DescribePipeline

describePipeline_pipelineName :: Lens' DescribePipeline Text Source #

The name of the pipeline to describe.

describePipelineResponse_createdBy :: Lens' DescribePipelineResponse (Maybe UserContext) Source #

Undocumented member.

describePipelineResponse_creationTime :: Lens' DescribePipelineResponse (Maybe UTCTime) Source #

The time when the pipeline was created.

describePipelineResponse_lastModifiedBy :: Lens' DescribePipelineResponse (Maybe UserContext) Source #

Undocumented member.

describePipelineResponse_lastModifiedTime :: Lens' DescribePipelineResponse (Maybe UTCTime) Source #

The time when the pipeline was last modified.

describePipelineResponse_lastRunTime :: Lens' DescribePipelineResponse (Maybe UTCTime) Source #

The time when the pipeline was last run.

describePipelineResponse_parallelismConfiguration :: Lens' DescribePipelineResponse (Maybe ParallelismConfiguration) Source #

Lists the parallelism configuration applied to the pipeline.

describePipelineResponse_pipelineArn :: Lens' DescribePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline.

describePipelineResponse_pipelineDefinition :: Lens' DescribePipelineResponse (Maybe Text) Source #

The JSON pipeline definition.

describePipelineResponse_pipelineDescription :: Lens' DescribePipelineResponse (Maybe Text) Source #

The description of the pipeline.

describePipelineResponse_pipelineDisplayName :: Lens' DescribePipelineResponse (Maybe Text) Source #

The display name of the pipeline.

describePipelineResponse_pipelineName :: Lens' DescribePipelineResponse (Maybe Text) Source #

The name of the pipeline.

describePipelineResponse_pipelineStatus :: Lens' DescribePipelineResponse (Maybe PipelineStatus) Source #

The status of the pipeline execution.

describePipelineResponse_roleArn :: Lens' DescribePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) that the pipeline uses to execute.

describePipelineResponse_httpStatus :: Lens' DescribePipelineResponse Int Source #

The response's http status code.

DescribePipelineDefinitionForExecution

describePipelineDefinitionForExecution_pipelineExecutionArn :: Lens' DescribePipelineDefinitionForExecution Text Source #

The Amazon Resource Name (ARN) of the pipeline execution.

describePipelineDefinitionForExecutionResponse_creationTime :: Lens' DescribePipelineDefinitionForExecutionResponse (Maybe UTCTime) Source #

The time when the pipeline was created.

describePipelineDefinitionForExecutionResponse_pipelineDefinition :: Lens' DescribePipelineDefinitionForExecutionResponse (Maybe Text) Source #

The JSON pipeline definition.

describePipelineDefinitionForExecutionResponse_httpStatus :: Lens' DescribePipelineDefinitionForExecutionResponse Int Source #

The response's http status code.

DescribePipelineExecution

describePipelineExecution_pipelineExecutionArn :: Lens' DescribePipelineExecution Text Source #

The Amazon Resource Name (ARN) of the pipeline execution.

describePipelineExecutionResponse_createdBy :: Lens' DescribePipelineExecutionResponse (Maybe UserContext) Source #

Undocumented member.

describePipelineExecutionResponse_creationTime :: Lens' DescribePipelineExecutionResponse (Maybe UTCTime) Source #

The time when the pipeline execution was created.

describePipelineExecutionResponse_failureReason :: Lens' DescribePipelineExecutionResponse (Maybe Text) Source #

If the execution failed, a message describing why.

describePipelineExecutionResponse_lastModifiedBy :: Lens' DescribePipelineExecutionResponse (Maybe UserContext) Source #

Undocumented member.

describePipelineExecutionResponse_lastModifiedTime :: Lens' DescribePipelineExecutionResponse (Maybe UTCTime) Source #

The time when the pipeline execution was modified last.

describePipelineExecutionResponse_parallelismConfiguration :: Lens' DescribePipelineExecutionResponse (Maybe ParallelismConfiguration) Source #

The parallelism configuration applied to the pipeline.

describePipelineExecutionResponse_pipelineArn :: Lens' DescribePipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline.

describePipelineExecutionResponse_pipelineExecutionArn :: Lens' DescribePipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

describePipelineExecutionResponse_pipelineExecutionDescription :: Lens' DescribePipelineExecutionResponse (Maybe Text) Source #

The description of the pipeline execution.

describePipelineExecutionResponse_pipelineExecutionDisplayName :: Lens' DescribePipelineExecutionResponse (Maybe Text) Source #

The display name of the pipeline execution.

describePipelineExecutionResponse_pipelineExecutionStatus :: Lens' DescribePipelineExecutionResponse (Maybe PipelineExecutionStatus) Source #

The status of the pipeline execution.

describePipelineExecutionResponse_pipelineExperimentConfig :: Lens' DescribePipelineExecutionResponse (Maybe PipelineExperimentConfig) Source #

Undocumented member.

describePipelineExecutionResponse_httpStatus :: Lens' DescribePipelineExecutionResponse Int Source #

The response's http status code.

DescribeProcessingJob

describeProcessingJob_processingJobName :: Lens' DescribeProcessingJob Text Source #

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeProcessingJobResponse_autoMLJobArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The ARN of an AutoML job associated with this processing job.

describeProcessingJobResponse_environment :: Lens' DescribeProcessingJobResponse (Maybe (HashMap Text Text)) Source #

The environment variables set in the Docker container.

describeProcessingJobResponse_exitMessage :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

describeProcessingJobResponse_experimentConfig :: Lens' DescribeProcessingJobResponse (Maybe ExperimentConfig) Source #

The configuration information used to create an experiment.

describeProcessingJobResponse_failureReason :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

describeProcessingJobResponse_lastModifiedTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job was last modified.

describeProcessingJobResponse_monitoringScheduleArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The ARN of a monitoring schedule for an endpoint associated with this processing job.

describeProcessingJobResponse_networkConfig :: Lens' DescribeProcessingJobResponse (Maybe NetworkConfig) Source #

Networking options for a processing job.

describeProcessingJobResponse_processingEndTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job completed.

describeProcessingJobResponse_processingInputs :: Lens' DescribeProcessingJobResponse (Maybe [ProcessingInput]) Source #

The inputs for a processing job.

describeProcessingJobResponse_processingOutputConfig :: Lens' DescribeProcessingJobResponse (Maybe ProcessingOutputConfig) Source #

Output configuration for the processing job.

describeProcessingJobResponse_processingStartTime :: Lens' DescribeProcessingJobResponse (Maybe UTCTime) Source #

The time at which the processing job started.

describeProcessingJobResponse_roleArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

describeProcessingJobResponse_stoppingCondition :: Lens' DescribeProcessingJobResponse (Maybe ProcessingStoppingCondition) Source #

The time limit for how long the processing job is allowed to run.

describeProcessingJobResponse_trainingJobArn :: Lens' DescribeProcessingJobResponse (Maybe Text) Source #

The ARN of a training job associated with this processing job.

describeProcessingJobResponse_httpStatus :: Lens' DescribeProcessingJobResponse Int Source #

The response's http status code.

describeProcessingJobResponse_processingJobName :: Lens' DescribeProcessingJobResponse Text Source #

The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.

describeProcessingJobResponse_processingResources :: Lens' DescribeProcessingJobResponse ProcessingResources Source #

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.

describeProcessingJobResponse_appSpecification :: Lens' DescribeProcessingJobResponse AppSpecification Source #

Configures the processing job to run a specified container image.

describeProcessingJobResponse_processingJobArn :: Lens' DescribeProcessingJobResponse Text Source #

The Amazon Resource Name (ARN) of the processing job.

describeProcessingJobResponse_processingJobStatus :: Lens' DescribeProcessingJobResponse ProcessingJobStatus Source #

Provides the status of a processing job.

describeProcessingJobResponse_creationTime :: Lens' DescribeProcessingJobResponse UTCTime Source #

The time at which the processing job was created.

DescribeProject

describeProject_projectName :: Lens' DescribeProject Text Source #

The name of the project to describe.

describeProjectResponse_createdBy :: Lens' DescribeProjectResponse (Maybe UserContext) Source #

Undocumented member.

describeProjectResponse_lastModifiedBy :: Lens' DescribeProjectResponse (Maybe UserContext) Source #

Undocumented member.

describeProjectResponse_lastModifiedTime :: Lens' DescribeProjectResponse (Maybe UTCTime) Source #

The timestamp when project was last modified.

describeProjectResponse_projectDescription :: Lens' DescribeProjectResponse (Maybe Text) Source #

The description of the project.

describeProjectResponse_serviceCatalogProvisionedProductDetails :: Lens' DescribeProjectResponse (Maybe ServiceCatalogProvisionedProductDetails) Source #

Information about a provisioned service catalog product.

describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int Source #

The response's http status code.

describeProjectResponse_projectArn :: Lens' DescribeProjectResponse Text Source #

The Amazon Resource Name (ARN) of the project.

describeProjectResponse_projectName :: Lens' DescribeProjectResponse Text Source #

The name of the project.

describeProjectResponse_projectId :: Lens' DescribeProjectResponse Text Source #

The ID of the project.

describeProjectResponse_serviceCatalogProvisioningDetails :: Lens' DescribeProjectResponse ServiceCatalogProvisioningDetails Source #

Information used to provision a service catalog product. For information, see What is Amazon Web Services Service Catalog.

describeProjectResponse_projectStatus :: Lens' DescribeProjectResponse ProjectStatus Source #

The status of the project.

describeProjectResponse_creationTime :: Lens' DescribeProjectResponse UTCTime Source #

The time when the project was created.

DescribeSpace

describeSpace_domainId :: Lens' DescribeSpace Text Source #

The ID of the associated Domain.

describeSpace_spaceName :: Lens' DescribeSpace Text Source #

The name of the space.

describeSpaceResponse_creationTime :: Lens' DescribeSpaceResponse (Maybe UTCTime) Source #

The creation time.

describeSpaceResponse_domainId :: Lens' DescribeSpaceResponse (Maybe Text) Source #

The ID of the associated Domain.

describeSpaceResponse_failureReason :: Lens' DescribeSpaceResponse (Maybe Text) Source #

The failure reason.

describeSpaceResponse_homeEfsFileSystemUid :: Lens' DescribeSpaceResponse (Maybe Text) Source #

The ID of the space's profile in the Amazon Elastic File System volume.

describeSpaceResponse_lastModifiedTime :: Lens' DescribeSpaceResponse (Maybe UTCTime) Source #

The last modified time.

describeSpaceResponse_spaceArn :: Lens' DescribeSpaceResponse (Maybe Text) Source #

The space's Amazon Resource Name (ARN).

describeSpaceResponse_spaceName :: Lens' DescribeSpaceResponse (Maybe Text) Source #

The name of the space.

describeSpaceResponse_spaceSettings :: Lens' DescribeSpaceResponse (Maybe SpaceSettings) Source #

A collection of space settings.

describeSpaceResponse_status :: Lens' DescribeSpaceResponse (Maybe SpaceStatus) Source #

The status.

describeSpaceResponse_httpStatus :: Lens' DescribeSpaceResponse Int Source #

The response's http status code.

DescribeStudioLifecycleConfig

describeStudioLifecycleConfig_studioLifecycleConfigName :: Lens' DescribeStudioLifecycleConfig Text Source #

The name of the Studio Lifecycle Configuration to describe.

describeStudioLifecycleConfigResponse_creationTime :: Lens' DescribeStudioLifecycleConfigResponse (Maybe UTCTime) Source #

The creation time of the Studio Lifecycle Configuration.

describeStudioLifecycleConfigResponse_lastModifiedTime :: Lens' DescribeStudioLifecycleConfigResponse (Maybe UTCTime) Source #

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

describeStudioLifecycleConfigResponse_studioLifecycleConfigAppType :: Lens' DescribeStudioLifecycleConfigResponse (Maybe StudioLifecycleConfigAppType) Source #

The App type that the Lifecycle Configuration is attached to.

describeStudioLifecycleConfigResponse_studioLifecycleConfigArn :: Lens' DescribeStudioLifecycleConfigResponse (Maybe Text) Source #

The ARN of the Lifecycle Configuration to describe.

describeStudioLifecycleConfigResponse_studioLifecycleConfigContent :: Lens' DescribeStudioLifecycleConfigResponse (Maybe Text) Source #

The content of your Studio Lifecycle Configuration script.

describeStudioLifecycleConfigResponse_studioLifecycleConfigName :: Lens' DescribeStudioLifecycleConfigResponse (Maybe Text) Source #

The name of the Studio Lifecycle Configuration that is described.

describeStudioLifecycleConfigResponse_httpStatus :: Lens' DescribeStudioLifecycleConfigResponse Int Source #

The response's http status code.

DescribeSubscribedWorkteam

describeSubscribedWorkteam_workteamArn :: Lens' DescribeSubscribedWorkteam Text Source #

The Amazon Resource Name (ARN) of the subscribed work team to describe.

describeSubscribedWorkteamResponse_httpStatus :: Lens' DescribeSubscribedWorkteamResponse Int Source #

The response's http status code.

describeSubscribedWorkteamResponse_subscribedWorkteam :: Lens' DescribeSubscribedWorkteamResponse SubscribedWorkteam Source #

A Workteam instance that contains information about the work team.

DescribeTrainingJob

describeTrainingJob_trainingJobName :: Lens' DescribeTrainingJob Text Source #

The name of the training job.

describeTrainingJobResponse_autoMLJobArn :: Lens' DescribeTrainingJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of an AutoML job.

describeTrainingJobResponse_billableTimeInSeconds :: Lens' DescribeTrainingJobResponse (Maybe Natural) Source #

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

describeTrainingJobResponse_checkpointConfig :: Lens' DescribeTrainingJobResponse (Maybe CheckpointConfig) Source #

Undocumented member.

describeTrainingJobResponse_debugHookConfig :: Lens' DescribeTrainingJobResponse (Maybe DebugHookConfig) Source #

Undocumented member.

describeTrainingJobResponse_debugRuleConfigurations :: Lens' DescribeTrainingJobResponse (Maybe [DebugRuleConfiguration]) Source #

Configuration information for Amazon SageMaker Debugger rules for debugging output tensors.

describeTrainingJobResponse_debugRuleEvaluationStatuses :: Lens' DescribeTrainingJobResponse (Maybe [DebugRuleEvaluationStatus]) Source #

Evaluation status of Amazon SageMaker Debugger rules for debugging on a training job.

describeTrainingJobResponse_enableInterContainerTrafficEncryption :: Lens' DescribeTrainingJobResponse (Maybe Bool) Source #

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

describeTrainingJobResponse_enableManagedSpotTraining :: Lens' DescribeTrainingJobResponse (Maybe Bool) Source #

A Boolean indicating whether managed spot training is enabled (True) or not (False).

describeTrainingJobResponse_enableNetworkIsolation :: Lens' DescribeTrainingJobResponse (Maybe Bool) Source #

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

describeTrainingJobResponse_environment :: Lens' DescribeTrainingJobResponse (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container.

describeTrainingJobResponse_experimentConfig :: Lens' DescribeTrainingJobResponse (Maybe ExperimentConfig) Source #

Undocumented member.

describeTrainingJobResponse_failureReason :: Lens' DescribeTrainingJobResponse (Maybe Text) Source #

If the training job failed, the reason it failed.

describeTrainingJobResponse_finalMetricDataList :: Lens' DescribeTrainingJobResponse (Maybe [MetricData]) Source #

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

describeTrainingJobResponse_hyperParameters :: Lens' DescribeTrainingJobResponse (Maybe (HashMap Text Text)) Source #

Algorithm-specific parameters.

describeTrainingJobResponse_inputDataConfig :: Lens' DescribeTrainingJobResponse (Maybe (NonEmpty Channel)) Source #

An array of Channel objects that describes each data input channel.

describeTrainingJobResponse_labelingJobArn :: Lens' DescribeTrainingJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the SageMaker Ground Truth labeling job that created the transform or training job.

describeTrainingJobResponse_lastModifiedTime :: Lens' DescribeTrainingJobResponse (Maybe UTCTime) Source #

A timestamp that indicates when the status of the training job was last modified.

describeTrainingJobResponse_outputDataConfig :: Lens' DescribeTrainingJobResponse (Maybe OutputDataConfig) Source #

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

describeTrainingJobResponse_profilerConfig :: Lens' DescribeTrainingJobResponse (Maybe ProfilerConfig) Source #

Undocumented member.

describeTrainingJobResponse_profilerRuleConfigurations :: Lens' DescribeTrainingJobResponse (Maybe [ProfilerRuleConfiguration]) Source #

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

describeTrainingJobResponse_profilerRuleEvaluationStatuses :: Lens' DescribeTrainingJobResponse (Maybe [ProfilerRuleEvaluationStatus]) Source #

Evaluation status of Amazon SageMaker Debugger rules for profiling on a training job.

describeTrainingJobResponse_profilingStatus :: Lens' DescribeTrainingJobResponse (Maybe ProfilingStatus) Source #

Profiling status of a training job.

describeTrainingJobResponse_retryStrategy :: Lens' DescribeTrainingJobResponse (Maybe RetryStrategy) Source #

The number of times to retry the job when the job fails due to an InternalServerError.

describeTrainingJobResponse_roleArn :: Lens' DescribeTrainingJobResponse (Maybe Text) Source #

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

describeTrainingJobResponse_secondaryStatusTransitions :: Lens' DescribeTrainingJobResponse (Maybe [SecondaryStatusTransition]) Source #

A history of all of the secondary statuses that the training job has transitioned through.

describeTrainingJobResponse_tensorBoardOutputConfig :: Lens' DescribeTrainingJobResponse (Maybe TensorBoardOutputConfig) Source #

Undocumented member.

describeTrainingJobResponse_trainingEndTime :: Lens' DescribeTrainingJobResponse (Maybe UTCTime) Source #

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

describeTrainingJobResponse_trainingStartTime :: Lens' DescribeTrainingJobResponse (Maybe UTCTime) Source #

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

describeTrainingJobResponse_trainingTimeInSeconds :: Lens' DescribeTrainingJobResponse (Maybe Natural) Source #

The training time in seconds.

describeTrainingJobResponse_tuningJobArn :: Lens' DescribeTrainingJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

describeTrainingJobResponse_vpcConfig :: Lens' DescribeTrainingJobResponse (Maybe VpcConfig) Source #

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

describeTrainingJobResponse_warmPoolStatus :: Lens' DescribeTrainingJobResponse (Maybe WarmPoolStatus) Source #

The status of the warm pool associated with the training job.

describeTrainingJobResponse_httpStatus :: Lens' DescribeTrainingJobResponse Int Source #

The response's http status code.

describeTrainingJobResponse_trainingJobName :: Lens' DescribeTrainingJobResponse Text Source #

Name of the model training job.

describeTrainingJobResponse_trainingJobArn :: Lens' DescribeTrainingJobResponse Text Source #

The Amazon Resource Name (ARN) of the training job.

describeTrainingJobResponse_modelArtifacts :: Lens' DescribeTrainingJobResponse ModelArtifacts Source #

Information about the Amazon S3 location that is configured for storing model artifacts.

describeTrainingJobResponse_trainingJobStatus :: Lens' DescribeTrainingJobResponse TrainingJobStatus Source #

The status of the training job.

SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.
  • Completed - The training job has completed.
  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
  • Stopping - The training job is stopping.
  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

describeTrainingJobResponse_secondaryStatus :: Lens' DescribeTrainingJobResponse SecondaryStatus Source #

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
- Starting - Starting the training job.
  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
  • Training - Training is in progress.
  • Interrupted - The job stopped because the managed spot training instances were interrupted.
  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
- Completed - The training job has completed.
Failed
- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
Stopped
- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.
  • Stopped - The training job has stopped.
Stopping
- Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances
  • PreparingTraining
  • DownloadingTrainingImage

describeTrainingJobResponse_algorithmSpecification :: Lens' DescribeTrainingJobResponse AlgorithmSpecification Source #

Information about the algorithm used for training, and algorithm metadata.

describeTrainingJobResponse_resourceConfig :: Lens' DescribeTrainingJobResponse ResourceConfig Source #

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

describeTrainingJobResponse_stoppingCondition :: Lens' DescribeTrainingJobResponse StoppingCondition Source #

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

describeTrainingJobResponse_creationTime :: Lens' DescribeTrainingJobResponse UTCTime Source #

A timestamp that indicates when the training job was created.

DescribeTransformJob

describeTransformJob_transformJobName :: Lens' DescribeTransformJob Text Source #

The name of the transform job that you want to view details of.

describeTransformJobResponse_autoMLJobArn :: Lens' DescribeTransformJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AutoML transform job.

describeTransformJobResponse_batchStrategy :: Lens' DescribeTransformJobResponse (Maybe BatchStrategy) Source #

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record // is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

describeTransformJobResponse_dataCaptureConfig :: Lens' DescribeTransformJobResponse (Maybe BatchDataCaptureConfig) Source #

Configuration to control how SageMaker captures inference data.

describeTransformJobResponse_dataProcessing :: Lens' DescribeTransformJobResponse (Maybe DataProcessing) Source #

Undocumented member.

describeTransformJobResponse_environment :: Lens' DescribeTransformJobResponse (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

describeTransformJobResponse_experimentConfig :: Lens' DescribeTransformJobResponse (Maybe ExperimentConfig) Source #

Undocumented member.

describeTransformJobResponse_failureReason :: Lens' DescribeTransformJobResponse (Maybe Text) Source #

If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

describeTransformJobResponse_labelingJobArn :: Lens' DescribeTransformJobResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

describeTransformJobResponse_maxConcurrentTransforms :: Lens' DescribeTransformJobResponse (Maybe Natural) Source #

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

describeTransformJobResponse_maxPayloadInMB :: Lens' DescribeTransformJobResponse (Maybe Natural) Source #

The maximum payload size, in MB, used in the transform job.

describeTransformJobResponse_modelClientConfig :: Lens' DescribeTransformJobResponse (Maybe ModelClientConfig) Source #

The timeout and maximum number of retries for processing a transform job invocation.

describeTransformJobResponse_transformEndTime :: Lens' DescribeTransformJobResponse (Maybe UTCTime) Source #

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

describeTransformJobResponse_transformOutput :: Lens' DescribeTransformJobResponse (Maybe TransformOutput) Source #

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

describeTransformJobResponse_transformStartTime :: Lens' DescribeTransformJobResponse (Maybe UTCTime) Source #

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

describeTransformJobResponse_httpStatus :: Lens' DescribeTransformJobResponse Int Source #

The response's http status code.

describeTransformJobResponse_transformJobName :: Lens' DescribeTransformJobResponse Text Source #

The name of the transform job.

describeTransformJobResponse_transformJobArn :: Lens' DescribeTransformJobResponse Text Source #

The Amazon Resource Name (ARN) of the transform job.

describeTransformJobResponse_transformJobStatus :: Lens' DescribeTransformJobResponse TransformJobStatus Source #

The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

describeTransformJobResponse_modelName :: Lens' DescribeTransformJobResponse Text Source #

The name of the model used in the transform job.

describeTransformJobResponse_transformInput :: Lens' DescribeTransformJobResponse TransformInput Source #

Describes the dataset to be transformed and the Amazon S3 location where it is stored.

describeTransformJobResponse_transformResources :: Lens' DescribeTransformJobResponse TransformResources Source #

Describes the resources, including ML instance types and ML instance count, to use for the transform job.

describeTransformJobResponse_creationTime :: Lens' DescribeTransformJobResponse UTCTime Source #

A timestamp that shows when the transform Job was created.

DescribeTrial

describeTrial_trialName :: Lens' DescribeTrial Text Source #

The name of the trial to describe.

describeTrialResponse_createdBy :: Lens' DescribeTrialResponse (Maybe UserContext) Source #

Who created the trial.

describeTrialResponse_creationTime :: Lens' DescribeTrialResponse (Maybe UTCTime) Source #

When the trial was created.

describeTrialResponse_displayName :: Lens' DescribeTrialResponse (Maybe Text) Source #

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

describeTrialResponse_experimentName :: Lens' DescribeTrialResponse (Maybe Text) Source #

The name of the experiment the trial is part of.

describeTrialResponse_lastModifiedBy :: Lens' DescribeTrialResponse (Maybe UserContext) Source #

Who last modified the trial.

describeTrialResponse_lastModifiedTime :: Lens' DescribeTrialResponse (Maybe UTCTime) Source #

When the trial was last modified.

describeTrialResponse_metadataProperties :: Lens' DescribeTrialResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeTrialResponse_source :: Lens' DescribeTrialResponse (Maybe TrialSource) Source #

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

describeTrialResponse_trialArn :: Lens' DescribeTrialResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

describeTrialResponse_trialName :: Lens' DescribeTrialResponse (Maybe Text) Source #

The name of the trial.

describeTrialResponse_httpStatus :: Lens' DescribeTrialResponse Int Source #

The response's http status code.

DescribeTrialComponent

describeTrialComponent_trialComponentName :: Lens' DescribeTrialComponent Text Source #

The name of the trial component to describe.

describeTrialComponentResponse_createdBy :: Lens' DescribeTrialComponentResponse (Maybe UserContext) Source #

Who created the trial component.

describeTrialComponentResponse_creationTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime) Source #

When the component was created.

describeTrialComponentResponse_displayName :: Lens' DescribeTrialComponentResponse (Maybe Text) Source #

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

describeTrialComponentResponse_endTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime) Source #

When the component ended.

describeTrialComponentResponse_inputArtifacts :: Lens' DescribeTrialComponentResponse (Maybe (HashMap Text TrialComponentArtifact)) Source #

The input artifacts of the component.

describeTrialComponentResponse_lastModifiedBy :: Lens' DescribeTrialComponentResponse (Maybe UserContext) Source #

Who last modified the component.

describeTrialComponentResponse_lastModifiedTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime) Source #

When the component was last modified.

describeTrialComponentResponse_lineageGroupArn :: Lens' DescribeTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group.

describeTrialComponentResponse_metadataProperties :: Lens' DescribeTrialComponentResponse (Maybe MetadataProperties) Source #

Undocumented member.

describeTrialComponentResponse_metrics :: Lens' DescribeTrialComponentResponse (Maybe [TrialComponentMetricSummary]) Source #

The metrics for the component.

describeTrialComponentResponse_outputArtifacts :: Lens' DescribeTrialComponentResponse (Maybe (HashMap Text TrialComponentArtifact)) Source #

The output artifacts of the component.

describeTrialComponentResponse_parameters :: Lens' DescribeTrialComponentResponse (Maybe (HashMap Text TrialComponentParameterValue)) Source #

The hyperparameters of the component.

describeTrialComponentResponse_source :: Lens' DescribeTrialComponentResponse (Maybe TrialComponentSource) Source #

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

describeTrialComponentResponse_sources :: Lens' DescribeTrialComponentResponse (Maybe [TrialComponentSource]) Source #

A list of ARNs and, if applicable, job types for multiple sources of an experiment run.

describeTrialComponentResponse_startTime :: Lens' DescribeTrialComponentResponse (Maybe UTCTime) Source #

When the component started.

describeTrialComponentResponse_status :: Lens' DescribeTrialComponentResponse (Maybe TrialComponentStatus) Source #

The status of the component. States include:

  • InProgress
  • Completed
  • Failed

describeTrialComponentResponse_trialComponentArn :: Lens' DescribeTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

describeTrialComponentResponse_trialComponentName :: Lens' DescribeTrialComponentResponse (Maybe Text) Source #

The name of the trial component.

describeTrialComponentResponse_httpStatus :: Lens' DescribeTrialComponentResponse Int Source #

The response's http status code.

DescribeUserProfile

describeUserProfile_domainId :: Lens' DescribeUserProfile Text Source #

The domain ID.

describeUserProfile_userProfileName :: Lens' DescribeUserProfile Text Source #

The user profile name. This value is not case sensitive.

describeUserProfileResponse_creationTime :: Lens' DescribeUserProfileResponse (Maybe UTCTime) Source #

The creation time.

describeUserProfileResponse_domainId :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The ID of the domain that contains the profile.

describeUserProfileResponse_failureReason :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The failure reason.

describeUserProfileResponse_homeEfsFileSystemUid :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The ID of the user's profile in the Amazon Elastic File System (EFS) volume.

describeUserProfileResponse_lastModifiedTime :: Lens' DescribeUserProfileResponse (Maybe UTCTime) Source #

The last modified time.

describeUserProfileResponse_singleSignOnUserIdentifier :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The IAM Identity Center user identifier.

describeUserProfileResponse_singleSignOnUserValue :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The IAM Identity Center user value.

describeUserProfileResponse_status :: Lens' DescribeUserProfileResponse (Maybe UserProfileStatus) Source #

The status.

describeUserProfileResponse_userProfileArn :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The user profile Amazon Resource Name (ARN).

describeUserProfileResponse_userProfileName :: Lens' DescribeUserProfileResponse (Maybe Text) Source #

The user profile name.

describeUserProfileResponse_userSettings :: Lens' DescribeUserProfileResponse (Maybe UserSettings) Source #

A collection of settings.

describeUserProfileResponse_httpStatus :: Lens' DescribeUserProfileResponse Int Source #

The response's http status code.

DescribeWorkforce

describeWorkforce_workforceName :: Lens' DescribeWorkforce Text Source #

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

describeWorkforceResponse_httpStatus :: Lens' DescribeWorkforceResponse Int Source #

The response's http status code.

describeWorkforceResponse_workforce :: Lens' DescribeWorkforceResponse Workforce Source #

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

DescribeWorkteam

describeWorkteam_workteamName :: Lens' DescribeWorkteam Text Source #

The name of the work team to return a description of.

describeWorkteamResponse_httpStatus :: Lens' DescribeWorkteamResponse Int Source #

The response's http status code.

describeWorkteamResponse_workteam :: Lens' DescribeWorkteamResponse Workteam Source #

A Workteam instance that contains information about the work team.

DisableSagemakerServicecatalogPortfolio

disableSagemakerServicecatalogPortfolioResponse_httpStatus :: Lens' DisableSagemakerServicecatalogPortfolioResponse Int Source #

The response's http status code.

DisassociateTrialComponent

disassociateTrialComponent_trialComponentName :: Lens' DisassociateTrialComponent Text Source #

The name of the component to disassociate from the trial.

disassociateTrialComponent_trialName :: Lens' DisassociateTrialComponent Text Source #

The name of the trial to disassociate from.

disassociateTrialComponentResponse_trialArn :: Lens' DisassociateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

disassociateTrialComponentResponse_trialComponentArn :: Lens' DisassociateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

disassociateTrialComponentResponse_httpStatus :: Lens' DisassociateTrialComponentResponse Int Source #

The response's http status code.

EnableSagemakerServicecatalogPortfolio

enableSagemakerServicecatalogPortfolioResponse_httpStatus :: Lens' EnableSagemakerServicecatalogPortfolioResponse Int Source #

The response's http status code.

GetDeviceFleetReport

getDeviceFleetReport_deviceFleetName :: Lens' GetDeviceFleetReport Text Source #

The name of the fleet.

getDeviceFleetReportResponse_agentVersions :: Lens' GetDeviceFleetReportResponse (Maybe [AgentVersion]) Source #

The versions of Edge Manager agent deployed on the fleet.

getDeviceFleetReportResponse_description :: Lens' GetDeviceFleetReportResponse (Maybe Text) Source #

Description of the fleet.

getDeviceFleetReportResponse_deviceStats :: Lens' GetDeviceFleetReportResponse (Maybe DeviceStats) Source #

Status of devices.

getDeviceFleetReportResponse_modelStats :: Lens' GetDeviceFleetReportResponse (Maybe [EdgeModelStat]) Source #

Status of model on device.

getDeviceFleetReportResponse_outputConfig :: Lens' GetDeviceFleetReportResponse (Maybe EdgeOutputConfig) Source #

The output configuration for storing sample data collected by the fleet.

getDeviceFleetReportResponse_reportGenerated :: Lens' GetDeviceFleetReportResponse (Maybe UTCTime) Source #

Timestamp of when the report was generated.

getDeviceFleetReportResponse_httpStatus :: Lens' GetDeviceFleetReportResponse Int Source #

The response's http status code.

getDeviceFleetReportResponse_deviceFleetArn :: Lens' GetDeviceFleetReportResponse Text Source #

The Amazon Resource Name (ARN) of the device.

getDeviceFleetReportResponse_deviceFleetName :: Lens' GetDeviceFleetReportResponse Text Source #

The name of the fleet.

GetLineageGroupPolicy

getLineageGroupPolicy_lineageGroupName :: Lens' GetLineageGroupPolicy Text Source #

The name or Amazon Resource Name (ARN) of the lineage group.

getLineageGroupPolicyResponse_lineageGroupArn :: Lens' GetLineageGroupPolicyResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group.

getLineageGroupPolicyResponse_resourcePolicy :: Lens' GetLineageGroupPolicyResponse (Maybe Text) Source #

The resource policy that gives access to the lineage group in another account.

getLineageGroupPolicyResponse_httpStatus :: Lens' GetLineageGroupPolicyResponse Int Source #

The response's http status code.

GetModelPackageGroupPolicy

getModelPackageGroupPolicy_modelPackageGroupName :: Lens' GetModelPackageGroupPolicy Text Source #

The name of the model group for which to get the resource policy.

getModelPackageGroupPolicyResponse_httpStatus :: Lens' GetModelPackageGroupPolicyResponse Int Source #

The response's http status code.

getModelPackageGroupPolicyResponse_resourcePolicy :: Lens' GetModelPackageGroupPolicyResponse Text Source #

The resource policy for the model group.

GetSagemakerServicecatalogPortfolioStatus

getSagemakerServicecatalogPortfolioStatusResponse_status :: Lens' GetSagemakerServicecatalogPortfolioStatusResponse (Maybe SagemakerServicecatalogStatus) Source #

Whether Service Catalog is enabled or disabled in SageMaker.

getSagemakerServicecatalogPortfolioStatusResponse_httpStatus :: Lens' GetSagemakerServicecatalogPortfolioStatusResponse Int Source #

The response's http status code.

GetSearchSuggestions

getSearchSuggestions_suggestionQuery :: Lens' GetSearchSuggestions (Maybe SuggestionQuery) Source #

Limits the property names that are included in the response.

getSearchSuggestions_resource :: Lens' GetSearchSuggestions ResourceType Source #

The name of the Amazon SageMaker resource to search for.

getSearchSuggestionsResponse_propertyNameSuggestions :: Lens' GetSearchSuggestionsResponse (Maybe [PropertyNameSuggestion]) Source #

A list of property names for a Resource that match a SuggestionQuery.

getSearchSuggestionsResponse_httpStatus :: Lens' GetSearchSuggestionsResponse Int Source #

The response's http status code.

ImportHubContent

importHubContent_hubContentDescription :: Lens' ImportHubContent (Maybe Text) Source #

A description of the hub content to import.

importHubContent_hubContentDisplayName :: Lens' ImportHubContent (Maybe Text) Source #

The display name of the hub content to import.

importHubContent_hubContentMarkdown :: Lens' ImportHubContent (Maybe Text) Source #

Markdown files associated with the hub content to import.

importHubContent_hubContentSearchKeywords :: Lens' ImportHubContent (Maybe [Text]) Source #

The searchable keywords of the hub content.

importHubContent_hubContentVersion :: Lens' ImportHubContent (Maybe Text) Source #

The version of the hub content to import.

importHubContent_tags :: Lens' ImportHubContent (Maybe [Tag]) Source #

Any tags associated with the hub content.

importHubContent_hubContentName :: Lens' ImportHubContent Text Source #

The name of the hub content to import.

importHubContent_hubContentType :: Lens' ImportHubContent HubContentType Source #

The type of hub content to import.

importHubContent_documentSchemaVersion :: Lens' ImportHubContent Text Source #

The version of the hub content schema to import.

importHubContent_hubName :: Lens' ImportHubContent Text Source #

The name of the hub to import content into.

importHubContent_hubContentDocument :: Lens' ImportHubContent Text Source #

The hub content document that describes information about the hub content such as type, associated containers, scripts, and more.

importHubContentResponse_httpStatus :: Lens' ImportHubContentResponse Int Source #

The response's http status code.

importHubContentResponse_hubArn :: Lens' ImportHubContentResponse Text Source #

The ARN of the hub that the content was imported into.

importHubContentResponse_hubContentArn :: Lens' ImportHubContentResponse Text Source #

The ARN of the hub content that was imported.

ListActions

listActions_actionType :: Lens' ListActions (Maybe Text) Source #

A filter that returns only actions of the specified type.

listActions_createdAfter :: Lens' ListActions (Maybe UTCTime) Source #

A filter that returns only actions created on or after the specified time.

listActions_createdBefore :: Lens' ListActions (Maybe UTCTime) Source #

A filter that returns only actions created on or before the specified time.

listActions_maxResults :: Lens' ListActions (Maybe Natural) Source #

The maximum number of actions to return in the response. The default value is 10.

listActions_nextToken :: Lens' ListActions (Maybe Text) Source #

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.

listActions_sortBy :: Lens' ListActions (Maybe SortActionsBy) Source #

The property used to sort results. The default value is CreationTime.

listActions_sortOrder :: Lens' ListActions (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listActions_sourceUri :: Lens' ListActions (Maybe Text) Source #

A filter that returns only actions with the specified source URI.

listActionsResponse_actionSummaries :: Lens' ListActionsResponse (Maybe [ActionSummary]) Source #

A list of actions and their properties.

listActionsResponse_nextToken :: Lens' ListActionsResponse (Maybe Text) Source #

A token for getting the next set of actions, if there are any.

listActionsResponse_httpStatus :: Lens' ListActionsResponse Int Source #

The response's http status code.

ListAlgorithms

listAlgorithms_creationTimeAfter :: Lens' ListAlgorithms (Maybe UTCTime) Source #

A filter that returns only algorithms created after the specified time (timestamp).

listAlgorithms_creationTimeBefore :: Lens' ListAlgorithms (Maybe UTCTime) Source #

A filter that returns only algorithms created before the specified time (timestamp).

listAlgorithms_maxResults :: Lens' ListAlgorithms (Maybe Natural) Source #

The maximum number of algorithms to return in the response.

listAlgorithms_nameContains :: Lens' ListAlgorithms (Maybe Text) Source #

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

listAlgorithms_nextToken :: Lens' ListAlgorithms (Maybe Text) Source #

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.

listAlgorithms_sortBy :: Lens' ListAlgorithms (Maybe AlgorithmSortBy) Source #

The parameter by which to sort the results. The default is CreationTime.

listAlgorithms_sortOrder :: Lens' ListAlgorithms (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listAlgorithmsResponse_nextToken :: Lens' ListAlgorithmsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

listAlgorithmsResponse_httpStatus :: Lens' ListAlgorithmsResponse Int Source #

The response's http status code.

listAlgorithmsResponse_algorithmSummaryList :: Lens' ListAlgorithmsResponse [AlgorithmSummary] Source #

An array of @AlgorithmSummary@ objects, each of which lists an

algorithm.

ListAliases

listAliases_alias :: Lens' ListAliases (Maybe Text) Source #

The alias of the image version.

listAliases_maxResults :: Lens' ListAliases (Maybe Natural) Source #

The maximum number of aliases to return.

listAliases_nextToken :: Lens' ListAliases (Maybe Text) Source #

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.

listAliases_version :: Lens' ListAliases (Maybe Natural) Source #

The version of the image. If image version is not specified, the aliases of all versions of the image are listed.

listAliases_imageName :: Lens' ListAliases Text Source #

The name of the image.

listAliasesResponse_nextToken :: Lens' ListAliasesResponse (Maybe Text) Source #

A token for getting the next set of aliases, if more aliases exist.

listAliasesResponse_sageMakerImageVersionAliases :: Lens' ListAliasesResponse (Maybe [Text]) Source #

A list of SageMaker image version aliases.

listAliasesResponse_httpStatus :: Lens' ListAliasesResponse Int Source #

The response's http status code.

ListAppImageConfigs

listAppImageConfigs_creationTimeAfter :: Lens' ListAppImageConfigs (Maybe UTCTime) Source #

A filter that returns only AppImageConfigs created on or after the specified time.

listAppImageConfigs_creationTimeBefore :: Lens' ListAppImageConfigs (Maybe UTCTime) Source #

A filter that returns only AppImageConfigs created on or before the specified time.

listAppImageConfigs_maxResults :: Lens' ListAppImageConfigs (Maybe Natural) Source #

The maximum number of AppImageConfigs to return in the response. The default value is 10.

listAppImageConfigs_modifiedTimeAfter :: Lens' ListAppImageConfigs (Maybe UTCTime) Source #

A filter that returns only AppImageConfigs modified on or after the specified time.

listAppImageConfigs_modifiedTimeBefore :: Lens' ListAppImageConfigs (Maybe UTCTime) Source #

A filter that returns only AppImageConfigs modified on or before the specified time.

listAppImageConfigs_nameContains :: Lens' ListAppImageConfigs (Maybe Text) Source #

A filter that returns only AppImageConfigs whose name contains the specified string.

listAppImageConfigs_nextToken :: Lens' ListAppImageConfigs (Maybe Text) Source #

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.

listAppImageConfigs_sortBy :: Lens' ListAppImageConfigs (Maybe AppImageConfigSortKey) Source #

The property used to sort results. The default value is CreationTime.

listAppImageConfigs_sortOrder :: Lens' ListAppImageConfigs (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listAppImageConfigsResponse_appImageConfigs :: Lens' ListAppImageConfigsResponse (Maybe [AppImageConfigDetails]) Source #

A list of AppImageConfigs and their properties.

listAppImageConfigsResponse_nextToken :: Lens' ListAppImageConfigsResponse (Maybe Text) Source #

A token for getting the next set of AppImageConfigs, if there are any.

listAppImageConfigsResponse_httpStatus :: Lens' ListAppImageConfigsResponse Int Source #

The response's http status code.

ListApps

listApps_domainIdEquals :: Lens' ListApps (Maybe Text) Source #

A parameter to search for the domain ID.

listApps_maxResults :: Lens' ListApps (Maybe Natural) Source #

Returns a list up to a specified limit.

listApps_nextToken :: Lens' ListApps (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listApps_sortBy :: Lens' ListApps (Maybe AppSortKey) Source #

The parameter by which to sort the results. The default is CreationTime.

listApps_sortOrder :: Lens' ListApps (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listApps_spaceNameEquals :: Lens' ListApps (Maybe Text) Source #

A parameter to search by space name. If UserProfileNameEquals is set, then this value cannot be set.

listApps_userProfileNameEquals :: Lens' ListApps (Maybe Text) Source #

A parameter to search by user profile name. If SpaceNameEquals is set, then this value cannot be set.

listAppsResponse_apps :: Lens' ListAppsResponse (Maybe [AppDetails]) Source #

The list of apps.

listAppsResponse_nextToken :: Lens' ListAppsResponse (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listAppsResponse_httpStatus :: Lens' ListAppsResponse Int Source #

The response's http status code.

ListArtifacts

listArtifacts_artifactType :: Lens' ListArtifacts (Maybe Text) Source #

A filter that returns only artifacts of the specified type.

listArtifacts_createdAfter :: Lens' ListArtifacts (Maybe UTCTime) Source #

A filter that returns only artifacts created on or after the specified time.

listArtifacts_createdBefore :: Lens' ListArtifacts (Maybe UTCTime) Source #

A filter that returns only artifacts created on or before the specified time.

listArtifacts_maxResults :: Lens' ListArtifacts (Maybe Natural) Source #

The maximum number of artifacts to return in the response. The default value is 10.

listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text) Source #

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.

listArtifacts_sortBy :: Lens' ListArtifacts (Maybe SortArtifactsBy) Source #

The property used to sort results. The default value is CreationTime.

listArtifacts_sortOrder :: Lens' ListArtifacts (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listArtifacts_sourceUri :: Lens' ListArtifacts (Maybe Text) Source #

A filter that returns only artifacts with the specified source URI.

listArtifactsResponse_artifactSummaries :: Lens' ListArtifactsResponse (Maybe [ArtifactSummary]) Source #

A list of artifacts and their properties.

listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text) Source #

A token for getting the next set of artifacts, if there are any.

listArtifactsResponse_httpStatus :: Lens' ListArtifactsResponse Int Source #

The response's http status code.

ListAssociations

listAssociations_associationType :: Lens' ListAssociations (Maybe AssociationEdgeType) Source #

A filter that returns only associations of the specified type.

listAssociations_createdAfter :: Lens' ListAssociations (Maybe UTCTime) Source #

A filter that returns only associations created on or after the specified time.

listAssociations_createdBefore :: Lens' ListAssociations (Maybe UTCTime) Source #

A filter that returns only associations created on or before the specified time.

listAssociations_destinationArn :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified destination Amazon Resource Name (ARN).

listAssociations_destinationType :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified destination type.

listAssociations_maxResults :: Lens' ListAssociations (Maybe Natural) Source #

The maximum number of associations to return in the response. The default value is 10.

listAssociations_nextToken :: Lens' ListAssociations (Maybe Text) Source #

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.

listAssociations_sortBy :: Lens' ListAssociations (Maybe SortAssociationsBy) Source #

The property used to sort results. The default value is CreationTime.

listAssociations_sortOrder :: Lens' ListAssociations (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listAssociations_sourceArn :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified source ARN.

listAssociations_sourceType :: Lens' ListAssociations (Maybe Text) Source #

A filter that returns only associations with the specified source type.

listAssociationsResponse_associationSummaries :: Lens' ListAssociationsResponse (Maybe [AssociationSummary]) Source #

A list of associations and their properties.

listAssociationsResponse_nextToken :: Lens' ListAssociationsResponse (Maybe Text) Source #

A token for getting the next set of associations, if there are any.

listAssociationsResponse_httpStatus :: Lens' ListAssociationsResponse Int Source #

The response's http status code.

ListAutoMLJobs

listAutoMLJobs_creationTimeAfter :: Lens' ListAutoMLJobs (Maybe UTCTime) Source #

Request a list of jobs, using a filter for time.

listAutoMLJobs_creationTimeBefore :: Lens' ListAutoMLJobs (Maybe UTCTime) Source #

Request a list of jobs, using a filter for time.

listAutoMLJobs_lastModifiedTimeAfter :: Lens' ListAutoMLJobs (Maybe UTCTime) Source #

Request a list of jobs, using a filter for time.

listAutoMLJobs_lastModifiedTimeBefore :: Lens' ListAutoMLJobs (Maybe UTCTime) Source #

Request a list of jobs, using a filter for time.

listAutoMLJobs_maxResults :: Lens' ListAutoMLJobs (Maybe Natural) Source #

Request a list of jobs up to a specified limit.

listAutoMLJobs_nameContains :: Lens' ListAutoMLJobs (Maybe Text) Source #

Request a list of jobs, using a search filter for name.

listAutoMLJobs_nextToken :: Lens' ListAutoMLJobs (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listAutoMLJobs_sortBy :: Lens' ListAutoMLJobs (Maybe AutoMLSortBy) Source #

The parameter by which to sort the results. The default is Name.

listAutoMLJobs_sortOrder :: Lens' ListAutoMLJobs (Maybe AutoMLSortOrder) Source #

The sort order for the results. The default is Descending.

listAutoMLJobs_statusEquals :: Lens' ListAutoMLJobs (Maybe AutoMLJobStatus) Source #

Request a list of jobs, using a filter for status.

listAutoMLJobsResponse_nextToken :: Lens' ListAutoMLJobsResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listAutoMLJobsResponse_httpStatus :: Lens' ListAutoMLJobsResponse Int Source #

The response's http status code.

listAutoMLJobsResponse_autoMLJobSummaries :: Lens' ListAutoMLJobsResponse [AutoMLJobSummary] Source #

Returns a summary list of jobs.

ListCandidatesForAutoMLJob

listCandidatesForAutoMLJob_candidateNameEquals :: Lens' ListCandidatesForAutoMLJob (Maybe Text) Source #

List the candidates for the job and filter by candidate name.

listCandidatesForAutoMLJob_maxResults :: Lens' ListCandidatesForAutoMLJob (Maybe Natural) Source #

List the job's candidates up to a specified limit.

listCandidatesForAutoMLJob_nextToken :: Lens' ListCandidatesForAutoMLJob (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listCandidatesForAutoMLJob_sortBy :: Lens' ListCandidatesForAutoMLJob (Maybe CandidateSortBy) Source #

The parameter by which to sort the results. The default is Descending.

listCandidatesForAutoMLJob_sortOrder :: Lens' ListCandidatesForAutoMLJob (Maybe AutoMLSortOrder) Source #

The sort order for the results. The default is Ascending.

listCandidatesForAutoMLJob_statusEquals :: Lens' ListCandidatesForAutoMLJob (Maybe CandidateStatus) Source #

List the candidates for the job and filter by status.

listCandidatesForAutoMLJob_autoMLJobName :: Lens' ListCandidatesForAutoMLJob Text Source #

List the candidates created for the job by providing the job's name.

listCandidatesForAutoMLJobResponse_nextToken :: Lens' ListCandidatesForAutoMLJobResponse (Maybe Text) Source #

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

listCandidatesForAutoMLJobResponse_httpStatus :: Lens' ListCandidatesForAutoMLJobResponse Int Source #

The response's http status code.

listCandidatesForAutoMLJobResponse_candidates :: Lens' ListCandidatesForAutoMLJobResponse [AutoMLCandidate] Source #

Summaries about the AutoMLCandidates.

ListCodeRepositories

listCodeRepositories_creationTimeAfter :: Lens' ListCodeRepositories (Maybe UTCTime) Source #

A filter that returns only Git repositories that were created after the specified time.

listCodeRepositories_creationTimeBefore :: Lens' ListCodeRepositories (Maybe UTCTime) Source #

A filter that returns only Git repositories that were created before the specified time.

listCodeRepositories_lastModifiedTimeAfter :: Lens' ListCodeRepositories (Maybe UTCTime) Source #

A filter that returns only Git repositories that were last modified after the specified time.

listCodeRepositories_lastModifiedTimeBefore :: Lens' ListCodeRepositories (Maybe UTCTime) Source #

A filter that returns only Git repositories that were last modified before the specified time.

listCodeRepositories_maxResults :: Lens' ListCodeRepositories (Maybe Natural) Source #

The maximum number of Git repositories to return in the response.

listCodeRepositories_nameContains :: Lens' ListCodeRepositories (Maybe Text) Source #

A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

listCodeRepositories_nextToken :: Lens' ListCodeRepositories (Maybe Text) Source #

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.

listCodeRepositories_sortBy :: Lens' ListCodeRepositories (Maybe CodeRepositorySortBy) Source #

The field to sort results by. The default is Name.

listCodeRepositories_sortOrder :: Lens' ListCodeRepositories (Maybe CodeRepositorySortOrder) Source #

The sort order for results. The default is Ascending.

listCodeRepositoriesResponse_nextToken :: Lens' ListCodeRepositoriesResponse (Maybe Text) Source #

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.

listCodeRepositoriesResponse_httpStatus :: Lens' ListCodeRepositoriesResponse Int Source #

The response's http status code.

listCodeRepositoriesResponse_codeRepositorySummaryList :: Lens' ListCodeRepositoriesResponse [CodeRepositorySummary] Source #

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.

ListCompilationJobs

listCompilationJobs_creationTimeAfter :: Lens' ListCompilationJobs (Maybe UTCTime) Source #

A filter that returns the model compilation jobs that were created after a specified time.

listCompilationJobs_creationTimeBefore :: Lens' ListCompilationJobs (Maybe UTCTime) Source #

A filter that returns the model compilation jobs that were created before a specified time.

listCompilationJobs_lastModifiedTimeAfter :: Lens' ListCompilationJobs (Maybe UTCTime) Source #

A filter that returns the model compilation jobs that were modified after a specified time.

listCompilationJobs_lastModifiedTimeBefore :: Lens' ListCompilationJobs (Maybe UTCTime) Source #

A filter that returns the model compilation jobs that were modified before a specified time.

listCompilationJobs_maxResults :: Lens' ListCompilationJobs (Maybe Natural) Source #

The maximum number of model compilation jobs to return in the response.

listCompilationJobs_nameContains :: Lens' ListCompilationJobs (Maybe Text) Source #

A filter that returns the model compilation jobs whose name contains a specified string.

listCompilationJobs_nextToken :: Lens' ListCompilationJobs (Maybe Text) Source #

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.

listCompilationJobs_sortBy :: Lens' ListCompilationJobs (Maybe ListCompilationJobsSortBy) Source #

The field by which to sort results. The default is CreationTime.

listCompilationJobs_sortOrder :: Lens' ListCompilationJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listCompilationJobs_statusEquals :: Lens' ListCompilationJobs (Maybe CompilationJobStatus) Source #

A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

listCompilationJobsResponse_nextToken :: Lens' ListCompilationJobsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

listCompilationJobsResponse_httpStatus :: Lens' ListCompilationJobsResponse Int Source #

The response's http status code.

listCompilationJobsResponse_compilationJobSummaries :: Lens' ListCompilationJobsResponse [CompilationJobSummary] Source #

An array of CompilationJobSummary objects, each describing a model compilation job.

ListContexts

listContexts_contextType :: Lens' ListContexts (Maybe Text) Source #

A filter that returns only contexts of the specified type.

listContexts_createdAfter :: Lens' ListContexts (Maybe UTCTime) Source #

A filter that returns only contexts created on or after the specified time.

listContexts_createdBefore :: Lens' ListContexts (Maybe UTCTime) Source #

A filter that returns only contexts created on or before the specified time.

listContexts_maxResults :: Lens' ListContexts (Maybe Natural) Source #

The maximum number of contexts to return in the response. The default value is 10.

listContexts_nextToken :: Lens' ListContexts (Maybe Text) Source #

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.

listContexts_sortBy :: Lens' ListContexts (Maybe SortContextsBy) Source #

The property used to sort results. The default value is CreationTime.

listContexts_sortOrder :: Lens' ListContexts (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listContexts_sourceUri :: Lens' ListContexts (Maybe Text) Source #

A filter that returns only contexts with the specified source URI.

listContextsResponse_contextSummaries :: Lens' ListContextsResponse (Maybe [ContextSummary]) Source #

A list of contexts and their properties.

listContextsResponse_nextToken :: Lens' ListContextsResponse (Maybe Text) Source #

A token for getting the next set of contexts, if there are any.

listContextsResponse_httpStatus :: Lens' ListContextsResponse Int Source #

The response's http status code.

ListDataQualityJobDefinitions

listDataQualityJobDefinitions_creationTimeAfter :: Lens' ListDataQualityJobDefinitions (Maybe UTCTime) Source #

A filter that returns only data quality monitoring job definitions created after the specified time.

listDataQualityJobDefinitions_creationTimeBefore :: Lens' ListDataQualityJobDefinitions (Maybe UTCTime) Source #

A filter that returns only data quality monitoring job definitions created before the specified time.

listDataQualityJobDefinitions_endpointName :: Lens' ListDataQualityJobDefinitions (Maybe Text) Source #

A filter that lists the data quality job definitions associated with the specified endpoint.

listDataQualityJobDefinitions_maxResults :: Lens' ListDataQualityJobDefinitions (Maybe Natural) Source #

The maximum number of data quality monitoring job definitions to return in the response.

listDataQualityJobDefinitions_nameContains :: Lens' ListDataQualityJobDefinitions (Maybe Text) Source #

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.

listDataQualityJobDefinitions_nextToken :: Lens' ListDataQualityJobDefinitions (Maybe Text) Source #

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

listDataQualityJobDefinitions_sortBy :: Lens' ListDataQualityJobDefinitions (Maybe MonitoringJobDefinitionSortKey) Source #

The field to sort results by. The default is CreationTime.

listDataQualityJobDefinitions_sortOrder :: Lens' ListDataQualityJobDefinitions (Maybe SortOrder) Source #

The sort order for results. The default is Descending.

listDataQualityJobDefinitionsResponse_nextToken :: Lens' ListDataQualityJobDefinitionsResponse (Maybe Text) Source #

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.

listDataQualityJobDefinitionsResponse_httpStatus :: Lens' ListDataQualityJobDefinitionsResponse Int Source #

The response's http status code.

listDataQualityJobDefinitionsResponse_jobDefinitionSummaries :: Lens' ListDataQualityJobDefinitionsResponse [MonitoringJobDefinitionSummary] Source #

A list of data quality monitoring job definitions.

ListDeviceFleets

listDeviceFleets_creationTimeAfter :: Lens' ListDeviceFleets (Maybe UTCTime) Source #

Filter fleets where packaging job was created after specified time.

listDeviceFleets_creationTimeBefore :: Lens' ListDeviceFleets (Maybe UTCTime) Source #

Filter fleets where the edge packaging job was created before specified time.

listDeviceFleets_lastModifiedTimeAfter :: Lens' ListDeviceFleets (Maybe UTCTime) Source #

Select fleets where the job was updated after X

listDeviceFleets_lastModifiedTimeBefore :: Lens' ListDeviceFleets (Maybe UTCTime) Source #

Select fleets where the job was updated before X

listDeviceFleets_maxResults :: Lens' ListDeviceFleets (Maybe Int) Source #

The maximum number of results to select.

listDeviceFleets_nameContains :: Lens' ListDeviceFleets (Maybe Text) Source #

Filter for fleets containing this name in their fleet device name.

listDeviceFleets_nextToken :: Lens' ListDeviceFleets (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listDeviceFleets_sortBy :: Lens' ListDeviceFleets (Maybe ListDeviceFleetsSortBy) Source #

The column to sort by.

listDeviceFleets_sortOrder :: Lens' ListDeviceFleets (Maybe SortOrder) Source #

What direction to sort in.

listDeviceFleetsResponse_nextToken :: Lens' ListDeviceFleetsResponse (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listDeviceFleetsResponse_httpStatus :: Lens' ListDeviceFleetsResponse Int Source #

The response's http status code.

listDeviceFleetsResponse_deviceFleetSummaries :: Lens' ListDeviceFleetsResponse [DeviceFleetSummary] Source #

Summary of the device fleet.

ListDevices

listDevices_deviceFleetName :: Lens' ListDevices (Maybe Text) Source #

Filter for fleets containing this name in their device fleet name.

listDevices_latestHeartbeatAfter :: Lens' ListDevices (Maybe UTCTime) Source #

Select fleets where the job was updated after X

listDevices_maxResults :: Lens' ListDevices (Maybe Int) Source #

Maximum number of results to select.

listDevices_modelName :: Lens' ListDevices (Maybe Text) Source #

A filter that searches devices that contains this name in any of their models.

listDevices_nextToken :: Lens' ListDevices (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listDevicesResponse_nextToken :: Lens' ListDevicesResponse (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listDevicesResponse_httpStatus :: Lens' ListDevicesResponse Int Source #

The response's http status code.

listDevicesResponse_deviceSummaries :: Lens' ListDevicesResponse [DeviceSummary] Source #

Summary of devices.

ListDomains

listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #

Returns a list up to a specified limit.

listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listDomainsResponse_domains :: Lens' ListDomainsResponse (Maybe [DomainDetails]) Source #

The list of domains.

listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #

The response's http status code.

ListEdgeDeploymentPlans

listEdgeDeploymentPlans_creationTimeAfter :: Lens' ListEdgeDeploymentPlans (Maybe UTCTime) Source #

Selects edge deployment plans created after this time.

listEdgeDeploymentPlans_creationTimeBefore :: Lens' ListEdgeDeploymentPlans (Maybe UTCTime) Source #

Selects edge deployment plans created before this time.

listEdgeDeploymentPlans_deviceFleetNameContains :: Lens' ListEdgeDeploymentPlans (Maybe Text) Source #

Selects edge deployment plans with a device fleet name containing this name.

listEdgeDeploymentPlans_lastModifiedTimeAfter :: Lens' ListEdgeDeploymentPlans (Maybe UTCTime) Source #

Selects edge deployment plans that were last updated after this time.

listEdgeDeploymentPlans_lastModifiedTimeBefore :: Lens' ListEdgeDeploymentPlans (Maybe UTCTime) Source #

Selects edge deployment plans that were last updated before this time.

listEdgeDeploymentPlans_maxResults :: Lens' ListEdgeDeploymentPlans (Maybe Int) Source #

The maximum number of results to select (50 by default).

listEdgeDeploymentPlans_nameContains :: Lens' ListEdgeDeploymentPlans (Maybe Text) Source #

Selects edge deployment plans with names containing this name.

listEdgeDeploymentPlans_nextToken :: Lens' ListEdgeDeploymentPlans (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listEdgeDeploymentPlans_sortBy :: Lens' ListEdgeDeploymentPlans (Maybe ListEdgeDeploymentPlansSortBy) Source #

The column by which to sort the edge deployment plans. Can be one of NAME, DEVICEFLEETNAME, CREATIONTIME, LASTMODIFIEDTIME.

listEdgeDeploymentPlans_sortOrder :: Lens' ListEdgeDeploymentPlans (Maybe SortOrder) Source #

The direction of the sorting (ascending or descending).

listEdgeDeploymentPlansResponse_nextToken :: Lens' ListEdgeDeploymentPlansResponse (Maybe Text) Source #

The token to use when calling the next page of results.

listEdgeDeploymentPlansResponse_httpStatus :: Lens' ListEdgeDeploymentPlansResponse Int Source #

The response's http status code.

listEdgeDeploymentPlansResponse_edgeDeploymentPlanSummaries :: Lens' ListEdgeDeploymentPlansResponse [EdgeDeploymentPlanSummary] Source #

List of summaries of edge deployment plans.

ListEdgePackagingJobs

listEdgePackagingJobs_creationTimeAfter :: Lens' ListEdgePackagingJobs (Maybe UTCTime) Source #

Select jobs where the job was created after specified time.

listEdgePackagingJobs_creationTimeBefore :: Lens' ListEdgePackagingJobs (Maybe UTCTime) Source #

Select jobs where the job was created before specified time.

listEdgePackagingJobs_lastModifiedTimeAfter :: Lens' ListEdgePackagingJobs (Maybe UTCTime) Source #

Select jobs where the job was updated after specified time.

listEdgePackagingJobs_lastModifiedTimeBefore :: Lens' ListEdgePackagingJobs (Maybe UTCTime) Source #

Select jobs where the job was updated before specified time.

listEdgePackagingJobs_maxResults :: Lens' ListEdgePackagingJobs (Maybe Int) Source #

Maximum number of results to select.

listEdgePackagingJobs_modelNameContains :: Lens' ListEdgePackagingJobs (Maybe Text) Source #

Filter for jobs where the model name contains this string.

listEdgePackagingJobs_nameContains :: Lens' ListEdgePackagingJobs (Maybe Text) Source #

Filter for jobs containing this name in their packaging job name.

listEdgePackagingJobs_nextToken :: Lens' ListEdgePackagingJobs (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listEdgePackagingJobs_sortBy :: Lens' ListEdgePackagingJobs (Maybe ListEdgePackagingJobsSortBy) Source #

Use to specify what column to sort by.

listEdgePackagingJobs_sortOrder :: Lens' ListEdgePackagingJobs (Maybe SortOrder) Source #

What direction to sort by.

listEdgePackagingJobs_statusEquals :: Lens' ListEdgePackagingJobs (Maybe EdgePackagingJobStatus) Source #

The job status to filter for.

listEdgePackagingJobsResponse_nextToken :: Lens' ListEdgePackagingJobsResponse (Maybe Text) Source #

Token to use when calling the next page of results.

listEdgePackagingJobsResponse_httpStatus :: Lens' ListEdgePackagingJobsResponse Int Source #

The response's http status code.

listEdgePackagingJobsResponse_edgePackagingJobSummaries :: Lens' ListEdgePackagingJobsResponse [EdgePackagingJobSummary] Source #

Summaries of edge packaging jobs.

ListEndpointConfigs

listEndpointConfigs_creationTimeAfter :: Lens' ListEndpointConfigs (Maybe UTCTime) Source #

A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

listEndpointConfigs_creationTimeBefore :: Lens' ListEndpointConfigs (Maybe UTCTime) Source #

A filter that returns only endpoint configurations created before the specified time (timestamp).

listEndpointConfigs_maxResults :: Lens' ListEndpointConfigs (Maybe Natural) Source #

The maximum number of training jobs to return in the response.

listEndpointConfigs_nameContains :: Lens' ListEndpointConfigs (Maybe Text) Source #

A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

listEndpointConfigs_nextToken :: Lens' ListEndpointConfigs (Maybe Text) Source #

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.

listEndpointConfigs_sortBy :: Lens' ListEndpointConfigs (Maybe EndpointConfigSortKey) Source #

The field to sort results by. The default is CreationTime.

listEndpointConfigs_sortOrder :: Lens' ListEndpointConfigs (Maybe OrderKey) Source #

The sort order for results. The default is Descending.

listEndpointConfigsResponse_nextToken :: Lens' ListEndpointConfigsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

listEndpointConfigsResponse_httpStatus :: Lens' ListEndpointConfigsResponse Int Source #

The response's http status code.

listEndpointConfigsResponse_endpointConfigs :: Lens' ListEndpointConfigsResponse [EndpointConfigSummary] Source #

An array of endpoint configurations.

ListEndpoints

listEndpoints_creationTimeAfter :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

listEndpoints_creationTimeBefore :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints that were created before the specified time (timestamp).

listEndpoints_lastModifiedTimeAfter :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints that were modified after the specified timestamp.

listEndpoints_lastModifiedTimeBefore :: Lens' ListEndpoints (Maybe UTCTime) Source #

A filter that returns only endpoints that were modified before the specified timestamp.

listEndpoints_maxResults :: Lens' ListEndpoints (Maybe Natural) Source #

The maximum number of endpoints to return in the response. This value defaults to 10.

listEndpoints_nameContains :: Lens' ListEndpoints (Maybe Text) Source #

A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

listEndpoints_nextToken :: Lens' ListEndpoints (Maybe Text) Source #

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.

listEndpoints_sortBy :: Lens' ListEndpoints (Maybe EndpointSortKey) Source #

Sorts the list of results. The default is CreationTime.

listEndpoints_sortOrder :: Lens' ListEndpoints (Maybe OrderKey) Source #

The sort order for results. The default is Descending.

listEndpoints_statusEquals :: Lens' ListEndpoints (Maybe EndpointStatus) Source #

A filter that returns only endpoints with the specified status.

listEndpointsResponse_nextToken :: Lens' ListEndpointsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

listEndpointsResponse_httpStatus :: Lens' ListEndpointsResponse Int Source #

The response's http status code.

listEndpointsResponse_endpoints :: Lens' ListEndpointsResponse [EndpointSummary] Source #

An array or endpoint objects.

ListExperiments

listExperiments_createdAfter :: Lens' ListExperiments (Maybe UTCTime) Source #

A filter that returns only experiments created after the specified time.

listExperiments_createdBefore :: Lens' ListExperiments (Maybe UTCTime) Source #

A filter that returns only experiments created before the specified time.

listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural) Source #

The maximum number of experiments to return in the response. The default value is 10.

listExperiments_nextToken :: Lens' ListExperiments (Maybe Text) Source #

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.

listExperiments_sortBy :: Lens' ListExperiments (Maybe SortExperimentsBy) Source #

The property used to sort results. The default value is CreationTime.

listExperiments_sortOrder :: Lens' ListExperiments (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listExperimentsResponse_experimentSummaries :: Lens' ListExperimentsResponse (Maybe [ExperimentSummary]) Source #

A list of the summaries of your experiments.

listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text) Source #

A token for getting the next set of experiments, if there are any.

listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int Source #

The response's http status code.

ListFeatureGroups

listFeatureGroups_creationTimeAfter :: Lens' ListFeatureGroups (Maybe UTCTime) Source #

Use this parameter to search for FeatureGroupss created after a specific date and time.

listFeatureGroups_creationTimeBefore :: Lens' ListFeatureGroups (Maybe UTCTime) Source #

Use this parameter to search for FeatureGroupss created before a specific date and time.

listFeatureGroups_featureGroupStatusEquals :: Lens' ListFeatureGroups (Maybe FeatureGroupStatus) Source #

A FeatureGroup status. Filters by FeatureGroup status.

listFeatureGroups_maxResults :: Lens' ListFeatureGroups (Maybe Natural) Source #

The maximum number of results returned by ListFeatureGroups.

listFeatureGroups_nameContains :: Lens' ListFeatureGroups (Maybe Text) Source #

A string that partially matches one or more FeatureGroups names. Filters FeatureGroups by name.

listFeatureGroups_nextToken :: Lens' ListFeatureGroups (Maybe Text) Source #

A token to resume pagination of ListFeatureGroups results.

listFeatureGroups_offlineStoreStatusEquals :: Lens' ListFeatureGroups (Maybe OfflineStoreStatusValue) Source #

An OfflineStore status. Filters by OfflineStore status.

listFeatureGroups_sortBy :: Lens' ListFeatureGroups (Maybe FeatureGroupSortBy) Source #

The value on which the feature group list is sorted.

listFeatureGroups_sortOrder :: Lens' ListFeatureGroups (Maybe FeatureGroupSortOrder) Source #

The order in which feature groups are listed.

listFeatureGroupsResponse_nextToken :: Lens' ListFeatureGroupsResponse (Maybe Text) Source #

A token to resume pagination of ListFeatureGroups results.

listFeatureGroupsResponse_httpStatus :: Lens' ListFeatureGroupsResponse Int Source #

The response's http status code.

listFeatureGroupsResponse_featureGroupSummaries :: Lens' ListFeatureGroupsResponse [FeatureGroupSummary] Source #

A summary of feature groups.

ListFlowDefinitions

listFlowDefinitions_creationTimeAfter :: Lens' ListFlowDefinitions (Maybe UTCTime) Source #

A filter that returns only flow definitions with a creation time greater than or equal to the specified timestamp.

listFlowDefinitions_creationTimeBefore :: Lens' ListFlowDefinitions (Maybe UTCTime) Source #

A filter that returns only flow definitions that were created before the specified timestamp.

listFlowDefinitions_maxResults :: Lens' ListFlowDefinitions (Maybe Natural) Source #

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.

listFlowDefinitions_nextToken :: Lens' ListFlowDefinitions (Maybe Text) Source #

A token to resume pagination.

listFlowDefinitions_sortOrder :: Lens' ListFlowDefinitions (Maybe SortOrder) Source #

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

listFlowDefinitionsResponse_nextToken :: Lens' ListFlowDefinitionsResponse (Maybe Text) Source #

A token to resume pagination.

listFlowDefinitionsResponse_httpStatus :: Lens' ListFlowDefinitionsResponse Int Source #

The response's http status code.

listFlowDefinitionsResponse_flowDefinitionSummaries :: Lens' ListFlowDefinitionsResponse [FlowDefinitionSummary] Source #

An array of objects describing the flow definitions.

ListHubContentVersions

listHubContentVersions_creationTimeAfter :: Lens' ListHubContentVersions (Maybe UTCTime) Source #

Only list hub content versions that were created after the time specified.

listHubContentVersions_creationTimeBefore :: Lens' ListHubContentVersions (Maybe UTCTime) Source #

Only list hub content versions that were created before the time specified.

listHubContentVersions_maxResults :: Lens' ListHubContentVersions (Maybe Natural) Source #

The maximum number of hub content versions to list.

listHubContentVersions_maxSchemaVersion :: Lens' ListHubContentVersions (Maybe Text) Source #

The upper bound of the hub content schema version.

listHubContentVersions_minVersion :: Lens' ListHubContentVersions (Maybe Text) Source #

The lower bound of the hub content versions to list.

listHubContentVersions_nextToken :: Lens' ListHubContentVersions (Maybe Text) Source #

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.

listHubContentVersions_sortBy :: Lens' ListHubContentVersions (Maybe HubContentSortBy) Source #

Sort hub content versions by either name or creation time.

listHubContentVersions_sortOrder :: Lens' ListHubContentVersions (Maybe SortOrder) Source #

Sort hub content versions by ascending or descending order.

listHubContentVersions_hubName :: Lens' ListHubContentVersions Text Source #

The name of the hub to list the content versions of.

listHubContentVersions_hubContentType :: Lens' ListHubContentVersions HubContentType Source #

The type of hub content to list versions of.

listHubContentVersions_hubContentName :: Lens' ListHubContentVersions Text Source #

The name of the hub content.

listHubContentVersionsResponse_nextToken :: Lens' ListHubContentVersionsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content versions, use it in the subsequent request.

listHubContentVersionsResponse_httpStatus :: Lens' ListHubContentVersionsResponse Int Source #

The response's http status code.

listHubContentVersionsResponse_hubContentSummaries :: Lens' ListHubContentVersionsResponse [HubContentInfo] Source #

The summaries of the listed hub content versions.

ListHubContents

listHubContents_creationTimeAfter :: Lens' ListHubContents (Maybe UTCTime) Source #

Only list hub content that was created after the time specified.

listHubContents_creationTimeBefore :: Lens' ListHubContents (Maybe UTCTime) Source #

Only list hub content that was created before the time specified.

listHubContents_maxResults :: Lens' ListHubContents (Maybe Natural) Source #

The maximum amount of hub content to list.

listHubContents_maxSchemaVersion :: Lens' ListHubContents (Maybe Text) Source #

The upper bound of the hub content schema verion.

listHubContents_nameContains :: Lens' ListHubContents (Maybe Text) Source #

Only list hub content if the name contains the specified string.

listHubContents_nextToken :: Lens' ListHubContents (Maybe Text) Source #

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.

listHubContents_sortBy :: Lens' ListHubContents (Maybe HubContentSortBy) Source #

Sort hub content versions by either name or creation time.

listHubContents_sortOrder :: Lens' ListHubContents (Maybe SortOrder) Source #

Sort hubs by ascending or descending order.

listHubContents_hubName :: Lens' ListHubContents Text Source #

The name of the hub to list the contents of.

listHubContents_hubContentType :: Lens' ListHubContents HubContentType Source #

The type of hub content to list.

listHubContentsResponse_nextToken :: Lens' ListHubContentsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of hub content, use it in the subsequent request.

listHubContentsResponse_httpStatus :: Lens' ListHubContentsResponse Int Source #

The response's http status code.

listHubContentsResponse_hubContentSummaries :: Lens' ListHubContentsResponse [HubContentInfo] Source #

The summaries of the listed hub content.

ListHubs

listHubs_creationTimeAfter :: Lens' ListHubs (Maybe UTCTime) Source #

Only list hubs that were created after the time specified.

listHubs_creationTimeBefore :: Lens' ListHubs (Maybe UTCTime) Source #

Only list hubs that were created before the time specified.

listHubs_lastModifiedTimeAfter :: Lens' ListHubs (Maybe UTCTime) Source #

Only list hubs that were last modified after the time specified.

listHubs_lastModifiedTimeBefore :: Lens' ListHubs (Maybe UTCTime) Source #

Only list hubs that were last modified before the time specified.

listHubs_maxResults :: Lens' ListHubs (Maybe Natural) Source #

The maximum number of hubs to list.

listHubs_nameContains :: Lens' ListHubs (Maybe Text) Source #

Only list hubs with names that contain the specified string.

listHubs_nextToken :: Lens' ListHubs (Maybe Text) Source #

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.

listHubs_sortBy :: Lens' ListHubs (Maybe HubSortBy) Source #

Sort hubs by either name or creation time.

listHubs_sortOrder :: Lens' ListHubs (Maybe SortOrder) Source #

Sort hubs by ascending or descending order.

listHubsResponse_nextToken :: Lens' ListHubsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of hubs, use it in the subsequent request.

listHubsResponse_httpStatus :: Lens' ListHubsResponse Int Source #

The response's http status code.

listHubsResponse_hubSummaries :: Lens' ListHubsResponse [HubInfo] Source #

The summaries of the listed hubs.

ListHumanTaskUis

listHumanTaskUis_creationTimeAfter :: Lens' ListHumanTaskUis (Maybe UTCTime) Source #

A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

listHumanTaskUis_creationTimeBefore :: Lens' ListHumanTaskUis (Maybe UTCTime) Source #

A filter that returns only human task user interfaces that were created before the specified timestamp.

listHumanTaskUis_maxResults :: Lens' ListHumanTaskUis (Maybe Natural) Source #

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.

listHumanTaskUis_nextToken :: Lens' ListHumanTaskUis (Maybe Text) Source #

A token to resume pagination.

listHumanTaskUis_sortOrder :: Lens' ListHumanTaskUis (Maybe SortOrder) Source #

An optional value that specifies whether you want the results sorted in Ascending or Descending order.

listHumanTaskUisResponse_nextToken :: Lens' ListHumanTaskUisResponse (Maybe Text) Source #

A token to resume pagination.

listHumanTaskUisResponse_httpStatus :: Lens' ListHumanTaskUisResponse Int Source #

The response's http status code.

listHumanTaskUisResponse_humanTaskUiSummaries :: Lens' ListHumanTaskUisResponse [HumanTaskUiSummary] Source #

An array of objects describing the human task user interfaces.

ListHyperParameterTuningJobs

listHyperParameterTuningJobs_creationTimeAfter :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were created after the specified time.

listHyperParameterTuningJobs_creationTimeBefore :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were created before the specified time.

listHyperParameterTuningJobs_lastModifiedTimeAfter :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were modified after the specified time.

listHyperParameterTuningJobs_lastModifiedTimeBefore :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were modified before the specified time.

listHyperParameterTuningJobs_maxResults :: Lens' ListHyperParameterTuningJobs (Maybe Natural) Source #

The maximum number of tuning jobs to return. The default value is 10.

listHyperParameterTuningJobs_nameContains :: Lens' ListHyperParameterTuningJobs (Maybe Text) Source #

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

listHyperParameterTuningJobs_nextToken :: Lens' ListHyperParameterTuningJobs (Maybe Text) Source #

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.

listHyperParameterTuningJobs_sortBy :: Lens' ListHyperParameterTuningJobs (Maybe HyperParameterTuningJobSortByOptions) Source #

The field to sort results by. The default is Name.

listHyperParameterTuningJobs_sortOrder :: Lens' ListHyperParameterTuningJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listHyperParameterTuningJobs_statusEquals :: Lens' ListHyperParameterTuningJobs (Maybe HyperParameterTuningJobStatus) Source #

A filter that returns only tuning jobs with the specified status.

listHyperParameterTuningJobsResponse_nextToken :: Lens' ListHyperParameterTuningJobsResponse (Maybe Text) Source #

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.

listHyperParameterTuningJobsResponse_httpStatus :: Lens' ListHyperParameterTuningJobsResponse Int Source #

The response's http status code.

listHyperParameterTuningJobsResponse_hyperParameterTuningJobSummaries :: Lens' ListHyperParameterTuningJobsResponse [HyperParameterTuningJobSummary] Source #

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

ListImageVersions

listImageVersions_creationTimeAfter :: Lens' ListImageVersions (Maybe UTCTime) Source #

A filter that returns only versions created on or after the specified time.

listImageVersions_creationTimeBefore :: Lens' ListImageVersions (Maybe UTCTime) Source #

A filter that returns only versions created on or before the specified time.

listImageVersions_lastModifiedTimeAfter :: Lens' ListImageVersions (Maybe UTCTime) Source #

A filter that returns only versions modified on or after the specified time.

listImageVersions_lastModifiedTimeBefore :: Lens' ListImageVersions (Maybe UTCTime) Source #

A filter that returns only versions modified on or before the specified time.

listImageVersions_maxResults :: Lens' ListImageVersions (Maybe Natural) Source #

The maximum number of versions to return in the response. The default value is 10.

listImageVersions_nextToken :: Lens' ListImageVersions (Maybe Text) Source #

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.

listImageVersions_sortBy :: Lens' ListImageVersions (Maybe ImageVersionSortBy) Source #

The property used to sort results. The default value is CREATION_TIME.

listImageVersions_sortOrder :: Lens' ListImageVersions (Maybe ImageVersionSortOrder) Source #

The sort order. The default value is DESCENDING.

listImageVersions_imageName :: Lens' ListImageVersions Text Source #

The name of the image to list the versions of.

listImageVersionsResponse_imageVersions :: Lens' ListImageVersionsResponse (Maybe [ImageVersion]) Source #

A list of versions and their properties.

listImageVersionsResponse_nextToken :: Lens' ListImageVersionsResponse (Maybe Text) Source #

A token for getting the next set of versions, if there are any.

listImageVersionsResponse_httpStatus :: Lens' ListImageVersionsResponse Int Source #

The response's http status code.

ListImages

listImages_creationTimeAfter :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images created on or after the specified time.

listImages_creationTimeBefore :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images created on or before the specified time.

listImages_lastModifiedTimeAfter :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images modified on or after the specified time.

listImages_lastModifiedTimeBefore :: Lens' ListImages (Maybe UTCTime) Source #

A filter that returns only images modified on or before the specified time.

listImages_maxResults :: Lens' ListImages (Maybe Natural) Source #

The maximum number of images to return in the response. The default value is 10.

listImages_nameContains :: Lens' ListImages (Maybe Text) Source #

A filter that returns only images whose name contains the specified string.

listImages_nextToken :: Lens' ListImages (Maybe Text) Source #

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.

listImages_sortBy :: Lens' ListImages (Maybe ImageSortBy) Source #

The property used to sort results. The default value is CREATION_TIME.

listImages_sortOrder :: Lens' ListImages (Maybe ImageSortOrder) Source #

The sort order. The default value is DESCENDING.

listImagesResponse_images :: Lens' ListImagesResponse (Maybe [Image]) Source #

A list of images and their properties.

listImagesResponse_nextToken :: Lens' ListImagesResponse (Maybe Text) Source #

A token for getting the next set of images, if there are any.

listImagesResponse_httpStatus :: Lens' ListImagesResponse Int Source #

The response's http status code.

ListInferenceExperiments

listInferenceExperiments_creationTimeAfter :: Lens' ListInferenceExperiments (Maybe UTCTime) Source #

Selects inference experiments which were created after this timestamp.

listInferenceExperiments_creationTimeBefore :: Lens' ListInferenceExperiments (Maybe UTCTime) Source #

Selects inference experiments which were created before this timestamp.

listInferenceExperiments_lastModifiedTimeAfter :: Lens' ListInferenceExperiments (Maybe UTCTime) Source #

Selects inference experiments which were last modified after this timestamp.

listInferenceExperiments_lastModifiedTimeBefore :: Lens' ListInferenceExperiments (Maybe UTCTime) Source #

Selects inference experiments which were last modified before this timestamp.

listInferenceExperiments_maxResults :: Lens' ListInferenceExperiments (Maybe Natural) Source #

The maximum number of results to select.

listInferenceExperiments_nameContains :: Lens' ListInferenceExperiments (Maybe Text) Source #

Selects inference experiments whose names contain this name.

listInferenceExperiments_nextToken :: Lens' ListInferenceExperiments (Maybe Text) Source #

The response from the last list when returning a list large enough to need tokening.

listInferenceExperiments_sortBy :: Lens' ListInferenceExperiments (Maybe SortInferenceExperimentsBy) Source #

The column by which to sort the listed inference experiments.

listInferenceExperiments_sortOrder :: Lens' ListInferenceExperiments (Maybe SortOrder) Source #

The direction of sorting (ascending or descending).

listInferenceExperiments_statusEquals :: Lens' ListInferenceExperiments (Maybe InferenceExperimentStatus) Source #

Selects inference experiments which are in this status. For the possible statuses, see DescribeInferenceExperimentResponse$Status.

listInferenceExperiments_type :: Lens' ListInferenceExperiments (Maybe InferenceExperimentType) Source #

Selects inference experiments of this type. For the possible types of inference experiments, see CreateInferenceExperimentRequest$Type.

listInferenceExperimentsResponse_inferenceExperiments :: Lens' ListInferenceExperimentsResponse (Maybe [InferenceExperimentSummary]) Source #

List of inference experiments.

listInferenceExperimentsResponse_nextToken :: Lens' ListInferenceExperimentsResponse (Maybe Text) Source #

The token to use when calling the next page of results.

listInferenceExperimentsResponse_httpStatus :: Lens' ListInferenceExperimentsResponse Int Source #

The response's http status code.

ListInferenceRecommendationsJobSteps

listInferenceRecommendationsJobSteps_maxResults :: Lens' ListInferenceRecommendationsJobSteps (Maybe Natural) Source #

The maximum number of results to return.

listInferenceRecommendationsJobSteps_nextToken :: Lens' ListInferenceRecommendationsJobSteps (Maybe Text) Source #

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.

listInferenceRecommendationsJobSteps_status :: Lens' ListInferenceRecommendationsJobSteps (Maybe RecommendationJobStatus) Source #

A filter to return benchmarks of a specified status. If this field is left empty, then all benchmarks are returned.

listInferenceRecommendationsJobSteps_stepType :: Lens' ListInferenceRecommendationsJobSteps (Maybe RecommendationStepType) Source #

A filter to return details about the specified type of subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

listInferenceRecommendationsJobSteps_jobName :: Lens' ListInferenceRecommendationsJobSteps Text Source #

The name for the Inference Recommender job.

listInferenceRecommendationsJobStepsResponse_nextToken :: Lens' ListInferenceRecommendationsJobStepsResponse (Maybe Text) Source #

A token that you can specify in your next request to return more results from the list.

listInferenceRecommendationsJobStepsResponse_steps :: Lens' ListInferenceRecommendationsJobStepsResponse (Maybe [InferenceRecommendationsJobStep]) Source #

A list of all subtask details in Inference Recommender.

listInferenceRecommendationsJobStepsResponse_httpStatus :: Lens' ListInferenceRecommendationsJobStepsResponse Int Source #

The response's http status code.

ListInferenceRecommendationsJobs

listInferenceRecommendationsJobs_creationTimeAfter :: Lens' ListInferenceRecommendationsJobs (Maybe UTCTime) Source #

A filter that returns only jobs created after the specified time (timestamp).

listInferenceRecommendationsJobs_creationTimeBefore :: Lens' ListInferenceRecommendationsJobs (Maybe UTCTime) Source #

A filter that returns only jobs created before the specified time (timestamp).

listInferenceRecommendationsJobs_lastModifiedTimeAfter :: Lens' ListInferenceRecommendationsJobs (Maybe UTCTime) Source #

A filter that returns only jobs that were last modified after the specified time (timestamp).

listInferenceRecommendationsJobs_lastModifiedTimeBefore :: Lens' ListInferenceRecommendationsJobs (Maybe UTCTime) Source #

A filter that returns only jobs that were last modified before the specified time (timestamp).

listInferenceRecommendationsJobs_maxResults :: Lens' ListInferenceRecommendationsJobs (Maybe Natural) Source #

The maximum number of recommendations to return in the response.

listInferenceRecommendationsJobs_nameContains :: Lens' ListInferenceRecommendationsJobs (Maybe Text) Source #

A string in the job name. This filter returns only recommendations whose name contains the specified string.

listInferenceRecommendationsJobs_nextToken :: Lens' ListInferenceRecommendationsJobs (Maybe Text) Source #

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.

listInferenceRecommendationsJobs_sortBy :: Lens' ListInferenceRecommendationsJobs (Maybe ListInferenceRecommendationsJobsSortBy) Source #

The parameter by which to sort the results.

listInferenceRecommendationsJobs_sortOrder :: Lens' ListInferenceRecommendationsJobs (Maybe SortOrder) Source #

The sort order for the results.

listInferenceRecommendationsJobs_statusEquals :: Lens' ListInferenceRecommendationsJobs (Maybe RecommendationJobStatus) Source #

A filter that retrieves only inference recommendations jobs with a specific status.

listInferenceRecommendationsJobsResponse_nextToken :: Lens' ListInferenceRecommendationsJobsResponse (Maybe Text) Source #

A token for getting the next set of recommendations, if there are any.

listInferenceRecommendationsJobsResponse_httpStatus :: Lens' ListInferenceRecommendationsJobsResponse Int Source #

The response's http status code.

listInferenceRecommendationsJobsResponse_inferenceRecommendationsJobs :: Lens' ListInferenceRecommendationsJobsResponse [InferenceRecommendationsJob] Source #

The recommendations created from the Amazon SageMaker Inference Recommender job.

ListLabelingJobs

listLabelingJobs_creationTimeAfter :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs created after the specified time (timestamp).

listLabelingJobs_creationTimeBefore :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs created before the specified time (timestamp).

listLabelingJobs_lastModifiedTimeAfter :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs modified after the specified time (timestamp).

listLabelingJobs_lastModifiedTimeBefore :: Lens' ListLabelingJobs (Maybe UTCTime) Source #

A filter that returns only labeling jobs modified before the specified time (timestamp).

listLabelingJobs_maxResults :: Lens' ListLabelingJobs (Maybe Natural) Source #

The maximum number of labeling jobs to return in each page of the response.

listLabelingJobs_nameContains :: Lens' ListLabelingJobs (Maybe Text) Source #

A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

listLabelingJobs_nextToken :: Lens' ListLabelingJobs (Maybe Text) Source #

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.

listLabelingJobs_sortBy :: Lens' ListLabelingJobs (Maybe SortBy) Source #

The field to sort results by. The default is CreationTime.

listLabelingJobs_sortOrder :: Lens' ListLabelingJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listLabelingJobs_statusEquals :: Lens' ListLabelingJobs (Maybe LabelingJobStatus) Source #

A filter that retrieves only labeling jobs with a specific status.

listLabelingJobsResponse_labelingJobSummaryList :: Lens' ListLabelingJobsResponse (Maybe [LabelingJobSummary]) Source #

An array of LabelingJobSummary objects, each describing a labeling job.

listLabelingJobsResponse_nextToken :: Lens' ListLabelingJobsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

listLabelingJobsResponse_httpStatus :: Lens' ListLabelingJobsResponse Int Source #

The response's http status code.

ListLabelingJobsForWorkteam

listLabelingJobsForWorkteam_creationTimeAfter :: Lens' ListLabelingJobsForWorkteam (Maybe UTCTime) Source #

A filter that returns only labeling jobs created after the specified time (timestamp).

listLabelingJobsForWorkteam_creationTimeBefore :: Lens' ListLabelingJobsForWorkteam (Maybe UTCTime) Source #

A filter that returns only labeling jobs created before the specified time (timestamp).

listLabelingJobsForWorkteam_jobReferenceCodeContains :: Lens' ListLabelingJobsForWorkteam (Maybe Text) Source #

A filter the limits jobs to only the ones whose job reference code contains the specified string.

listLabelingJobsForWorkteam_maxResults :: Lens' ListLabelingJobsForWorkteam (Maybe Natural) Source #

The maximum number of labeling jobs to return in each page of the response.

listLabelingJobsForWorkteam_nextToken :: Lens' ListLabelingJobsForWorkteam (Maybe Text) Source #

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.

listLabelingJobsForWorkteam_sortBy :: Lens' ListLabelingJobsForWorkteam (Maybe ListLabelingJobsForWorkteamSortByOptions) Source #

The field to sort results by. The default is CreationTime.

listLabelingJobsForWorkteam_sortOrder :: Lens' ListLabelingJobsForWorkteam (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listLabelingJobsForWorkteam_workteamArn :: Lens' ListLabelingJobsForWorkteam Text Source #

The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

listLabelingJobsForWorkteamResponse_nextToken :: Lens' ListLabelingJobsForWorkteamResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

listLabelingJobsForWorkteamResponse_httpStatus :: Lens' ListLabelingJobsForWorkteamResponse Int Source #

The response's http status code.

listLabelingJobsForWorkteamResponse_labelingJobSummaryList :: Lens' ListLabelingJobsForWorkteamResponse [LabelingJobForWorkteamSummary] Source #

An array of LabelingJobSummary objects, each describing a labeling job.

ListLineageGroups

listLineageGroups_createdAfter :: Lens' ListLineageGroups (Maybe UTCTime) Source #

A timestamp to filter against lineage groups created after a certain point in time.

listLineageGroups_createdBefore :: Lens' ListLineageGroups (Maybe UTCTime) Source #

A timestamp to filter against lineage groups created before a certain point in time.

listLineageGroups_maxResults :: Lens' ListLineageGroups (Maybe Natural) Source #

The maximum number of endpoints to return in the response. This value defaults to 10.

listLineageGroups_nextToken :: Lens' ListLineageGroups (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

listLineageGroups_sortBy :: Lens' ListLineageGroups (Maybe SortLineageGroupsBy) Source #

The parameter by which to sort the results. The default is CreationTime.

listLineageGroups_sortOrder :: Lens' ListLineageGroups (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listLineageGroupsResponse_lineageGroupSummaries :: Lens' ListLineageGroupsResponse (Maybe [LineageGroupSummary]) Source #

A list of lineage groups and their properties.

listLineageGroupsResponse_nextToken :: Lens' ListLineageGroupsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

listLineageGroupsResponse_httpStatus :: Lens' ListLineageGroupsResponse Int Source #

The response's http status code.

ListModelBiasJobDefinitions

listModelBiasJobDefinitions_creationTimeAfter :: Lens' ListModelBiasJobDefinitions (Maybe UTCTime) Source #

A filter that returns only model bias jobs created after a specified time.

listModelBiasJobDefinitions_creationTimeBefore :: Lens' ListModelBiasJobDefinitions (Maybe UTCTime) Source #

A filter that returns only model bias jobs created before a specified time.

listModelBiasJobDefinitions_endpointName :: Lens' ListModelBiasJobDefinitions (Maybe Text) Source #

Name of the endpoint to monitor for model bias.

listModelBiasJobDefinitions_maxResults :: Lens' ListModelBiasJobDefinitions (Maybe Natural) Source #

The maximum number of model bias jobs to return in the response. The default value is 10.

listModelBiasJobDefinitions_nameContains :: Lens' ListModelBiasJobDefinitions (Maybe Text) Source #

Filter for model bias jobs whose name contains a specified string.

listModelBiasJobDefinitions_nextToken :: Lens' ListModelBiasJobDefinitions (Maybe Text) Source #

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

listModelBiasJobDefinitions_sortBy :: Lens' ListModelBiasJobDefinitions (Maybe MonitoringJobDefinitionSortKey) Source #

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

listModelBiasJobDefinitions_sortOrder :: Lens' ListModelBiasJobDefinitions (Maybe SortOrder) Source #

Whether to sort the results in Ascending or Descending order. The default is Descending.

listModelBiasJobDefinitionsResponse_nextToken :: Lens' ListModelBiasJobDefinitionsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

listModelBiasJobDefinitionsResponse_httpStatus :: Lens' ListModelBiasJobDefinitionsResponse Int Source #

The response's http status code.

listModelBiasJobDefinitionsResponse_jobDefinitionSummaries :: Lens' ListModelBiasJobDefinitionsResponse [MonitoringJobDefinitionSummary] Source #

A JSON array in which each element is a summary for a model bias jobs.

ListModelCardExportJobs

listModelCardExportJobs_creationTimeAfter :: Lens' ListModelCardExportJobs (Maybe UTCTime) Source #

Only list model card export jobs that were created after the time specified.

listModelCardExportJobs_creationTimeBefore :: Lens' ListModelCardExportJobs (Maybe UTCTime) Source #

Only list model card export jobs that were created before the time specified.

listModelCardExportJobs_maxResults :: Lens' ListModelCardExportJobs (Maybe Natural) Source #

The maximum number of model card export jobs to list.

listModelCardExportJobs_modelCardExportJobNameContains :: Lens' ListModelCardExportJobs (Maybe Text) Source #

Only list model card export jobs with names that contain the specified string.

listModelCardExportJobs_modelCardVersion :: Lens' ListModelCardExportJobs (Maybe Int) Source #

List export jobs for the model card with the specified version.

listModelCardExportJobs_nextToken :: Lens' ListModelCardExportJobs (Maybe Text) Source #

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.

listModelCardExportJobs_sortBy :: Lens' ListModelCardExportJobs (Maybe ModelCardExportJobSortBy) Source #

Sort model card export jobs by either name or creation time. Sorts by creation time by default.

listModelCardExportJobs_sortOrder :: Lens' ListModelCardExportJobs (Maybe ModelCardExportJobSortOrder) Source #

Sort model card export jobs by ascending or descending order.

listModelCardExportJobs_statusEquals :: Lens' ListModelCardExportJobs (Maybe ModelCardExportJobStatus) Source #

Only list model card export jobs with the specified status.

listModelCardExportJobs_modelCardName :: Lens' ListModelCardExportJobs Text Source #

List export jobs for the model card with the specified name.

listModelCardExportJobsResponse_nextToken :: Lens' ListModelCardExportJobsResponse (Maybe Text) Source #

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.

listModelCardExportJobsResponse_httpStatus :: Lens' ListModelCardExportJobsResponse Int Source #

The response's http status code.

listModelCardExportJobsResponse_modelCardExportJobSummaries :: Lens' ListModelCardExportJobsResponse [ModelCardExportJobSummary] Source #

The summaries of the listed model card export jobs.

ListModelCardVersions

listModelCardVersions_creationTimeAfter :: Lens' ListModelCardVersions (Maybe UTCTime) Source #

Only list model card versions that were created after the time specified.

listModelCardVersions_creationTimeBefore :: Lens' ListModelCardVersions (Maybe UTCTime) Source #

Only list model card versions that were created before the time specified.

listModelCardVersions_maxResults :: Lens' ListModelCardVersions (Maybe Natural) Source #

The maximum number of model card versions to list.

listModelCardVersions_modelCardStatus :: Lens' ListModelCardVersions (Maybe ModelCardStatus) Source #

Only list model card versions with the specified approval status.

listModelCardVersions_nextToken :: Lens' ListModelCardVersions (Maybe Text) Source #

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.

listModelCardVersions_sortBy :: Lens' ListModelCardVersions (Maybe ModelCardVersionSortBy) Source #

Sort listed model card versions by version. Sorts by version by default.

listModelCardVersions_sortOrder :: Lens' ListModelCardVersions (Maybe ModelCardSortOrder) Source #

Sort model card versions by ascending or descending order.

listModelCardVersions_modelCardName :: Lens' ListModelCardVersions Text Source #

List model card versions for the model card with the specified name.

listModelCardVersionsResponse_nextToken :: Lens' ListModelCardVersionsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of model card versions, use it in the subsequent request.

listModelCardVersionsResponse_httpStatus :: Lens' ListModelCardVersionsResponse Int Source #

The response's http status code.

listModelCardVersionsResponse_modelCardVersionSummaryList :: Lens' ListModelCardVersionsResponse [ModelCardVersionSummary] Source #

The summaries of the listed versions of the model card.

ListModelCards

listModelCards_creationTimeAfter :: Lens' ListModelCards (Maybe UTCTime) Source #

Only list model cards that were created after the time specified.

listModelCards_creationTimeBefore :: Lens' ListModelCards (Maybe UTCTime) Source #

Only list model cards that were created before the time specified.

listModelCards_maxResults :: Lens' ListModelCards (Maybe Natural) Source #

The maximum number of model cards to list.

listModelCards_modelCardStatus :: Lens' ListModelCards (Maybe ModelCardStatus) Source #

Only list model cards with the specified approval status.

listModelCards_nameContains :: Lens' ListModelCards (Maybe Text) Source #

Only list model cards with names that contain the specified string.

listModelCards_nextToken :: Lens' ListModelCards (Maybe Text) Source #

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.

listModelCards_sortBy :: Lens' ListModelCards (Maybe ModelCardSortBy) Source #

Sort model cards by either name or creation time. Sorts by creation time by default.

listModelCards_sortOrder :: Lens' ListModelCards (Maybe ModelCardSortOrder) Source #

Sort model cards by ascending or descending order.

listModelCardsResponse_nextToken :: Lens' ListModelCardsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request.

listModelCardsResponse_httpStatus :: Lens' ListModelCardsResponse Int Source #

The response's http status code.

listModelCardsResponse_modelCardSummaries :: Lens' ListModelCardsResponse [ModelCardSummary] Source #

The summaries of the listed model cards.

ListModelExplainabilityJobDefinitions

listModelExplainabilityJobDefinitions_creationTimeAfter :: Lens' ListModelExplainabilityJobDefinitions (Maybe UTCTime) Source #

A filter that returns only model explainability jobs created after a specified time.

listModelExplainabilityJobDefinitions_creationTimeBefore :: Lens' ListModelExplainabilityJobDefinitions (Maybe UTCTime) Source #

A filter that returns only model explainability jobs created before a specified time.

listModelExplainabilityJobDefinitions_endpointName :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text) Source #

Name of the endpoint to monitor for model explainability.

listModelExplainabilityJobDefinitions_maxResults :: Lens' ListModelExplainabilityJobDefinitions (Maybe Natural) Source #

The maximum number of jobs to return in the response. The default value is 10.

listModelExplainabilityJobDefinitions_nameContains :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text) Source #

Filter for model explainability jobs whose name contains a specified string.

listModelExplainabilityJobDefinitions_nextToken :: Lens' ListModelExplainabilityJobDefinitions (Maybe Text) Source #

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

listModelExplainabilityJobDefinitions_sortBy :: Lens' ListModelExplainabilityJobDefinitions (Maybe MonitoringJobDefinitionSortKey) Source #

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

listModelExplainabilityJobDefinitions_sortOrder :: Lens' ListModelExplainabilityJobDefinitions (Maybe SortOrder) Source #

Whether to sort the results in Ascending or Descending order. The default is Descending.

listModelExplainabilityJobDefinitionsResponse_nextToken :: Lens' ListModelExplainabilityJobDefinitionsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

listModelExplainabilityJobDefinitionsResponse_httpStatus :: Lens' ListModelExplainabilityJobDefinitionsResponse Int Source #

The response's http status code.

listModelExplainabilityJobDefinitionsResponse_jobDefinitionSummaries :: Lens' ListModelExplainabilityJobDefinitionsResponse [MonitoringJobDefinitionSummary] Source #

A JSON array in which each element is a summary for a explainability bias jobs.

ListModelMetadata

listModelMetadata_maxResults :: Lens' ListModelMetadata (Maybe Natural) Source #

The maximum number of models to return in the response.

listModelMetadata_nextToken :: Lens' ListModelMetadata (Maybe Text) Source #

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.

listModelMetadata_searchExpression :: Lens' ListModelMetadata (Maybe ModelMetadataSearchExpression) Source #

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.

listModelMetadataResponse_nextToken :: Lens' ListModelMetadataResponse (Maybe Text) Source #

A token for getting the next set of recommendations, if there are any.

listModelMetadataResponse_httpStatus :: Lens' ListModelMetadataResponse Int Source #

The response's http status code.

listModelMetadataResponse_modelMetadataSummaries :: Lens' ListModelMetadataResponse [ModelMetadataSummary] Source #

A structure that holds model metadata.

ListModelPackageGroups

listModelPackageGroups_creationTimeAfter :: Lens' ListModelPackageGroups (Maybe UTCTime) Source #

A filter that returns only model groups created after the specified time.

listModelPackageGroups_creationTimeBefore :: Lens' ListModelPackageGroups (Maybe UTCTime) Source #

A filter that returns only model groups created before the specified time.

listModelPackageGroups_maxResults :: Lens' ListModelPackageGroups (Maybe Natural) Source #

The maximum number of results to return in the response.

listModelPackageGroups_nameContains :: Lens' ListModelPackageGroups (Maybe Text) Source #

A string in the model group name. This filter returns only model groups whose name contains the specified string.

listModelPackageGroups_nextToken :: Lens' ListModelPackageGroups (Maybe Text) Source #

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.

listModelPackageGroups_sortBy :: Lens' ListModelPackageGroups (Maybe ModelPackageGroupSortBy) Source #

The field to sort results by. The default is CreationTime.

listModelPackageGroups_sortOrder :: Lens' ListModelPackageGroups (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listModelPackageGroupsResponse_nextToken :: Lens' ListModelPackageGroupsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.

listModelPackageGroupsResponse_httpStatus :: Lens' ListModelPackageGroupsResponse Int Source #

The response's http status code.

listModelPackageGroupsResponse_modelPackageGroupSummaryList :: Lens' ListModelPackageGroupsResponse [ModelPackageGroupSummary] Source #

A list of summaries of the model groups in your Amazon Web Services account.

ListModelPackages

listModelPackages_creationTimeAfter :: Lens' ListModelPackages (Maybe UTCTime) Source #

A filter that returns only model packages created after the specified time (timestamp).

listModelPackages_creationTimeBefore :: Lens' ListModelPackages (Maybe UTCTime) Source #

A filter that returns only model packages created before the specified time (timestamp).

listModelPackages_maxResults :: Lens' ListModelPackages (Maybe Natural) Source #

The maximum number of model packages to return in the response.

listModelPackages_modelApprovalStatus :: Lens' ListModelPackages (Maybe ModelApprovalStatus) Source #

A filter that returns only the model packages with the specified approval status.

listModelPackages_modelPackageGroupName :: Lens' ListModelPackages (Maybe Text) Source #

A filter that returns only model versions that belong to the specified model group.

listModelPackages_modelPackageType :: Lens' ListModelPackages (Maybe ModelPackageType) Source #

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.

listModelPackages_nameContains :: Lens' ListModelPackages (Maybe Text) Source #

A string in the model package name. This filter returns only model packages whose name contains the specified string.

listModelPackages_nextToken :: Lens' ListModelPackages (Maybe Text) Source #

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.

listModelPackages_sortBy :: Lens' ListModelPackages (Maybe ModelPackageSortBy) Source #

The parameter by which to sort the results. The default is CreationTime.

listModelPackages_sortOrder :: Lens' ListModelPackages (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listModelPackagesResponse_nextToken :: Lens' ListModelPackagesResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

listModelPackagesResponse_httpStatus :: Lens' ListModelPackagesResponse Int Source #

The response's http status code.

listModelPackagesResponse_modelPackageSummaryList :: Lens' ListModelPackagesResponse [ModelPackageSummary] Source #

An array of ModelPackageSummary objects, each of which lists a model package.

ListModelQualityJobDefinitions

listModelQualityJobDefinitions_creationTimeAfter :: Lens' ListModelQualityJobDefinitions (Maybe UTCTime) Source #

A filter that returns only model quality monitoring job definitions created after the specified time.

listModelQualityJobDefinitions_creationTimeBefore :: Lens' ListModelQualityJobDefinitions (Maybe UTCTime) Source #

A filter that returns only model quality monitoring job definitions created before the specified time.

listModelQualityJobDefinitions_endpointName :: Lens' ListModelQualityJobDefinitions (Maybe Text) Source #

A filter that returns only model quality monitoring job definitions that are associated with the specified endpoint.

listModelQualityJobDefinitions_maxResults :: Lens' ListModelQualityJobDefinitions (Maybe Natural) Source #

The maximum number of results to return in a call to ListModelQualityJobDefinitions.

listModelQualityJobDefinitions_nameContains :: Lens' ListModelQualityJobDefinitions (Maybe Text) Source #

A string in the transform job name. This filter returns only model quality monitoring job definitions whose name contains the specified string.

listModelQualityJobDefinitions_nextToken :: Lens' ListModelQualityJobDefinitions (Maybe Text) Source #

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.

listModelQualityJobDefinitions_sortBy :: Lens' ListModelQualityJobDefinitions (Maybe MonitoringJobDefinitionSortKey) Source #

The field to sort results by. The default is CreationTime.

listModelQualityJobDefinitions_sortOrder :: Lens' ListModelQualityJobDefinitions (Maybe SortOrder) Source #

The sort order for results. The default is Descending.

listModelQualityJobDefinitionsResponse_nextToken :: Lens' ListModelQualityJobDefinitionsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model quality monitoring job definitions, use it in the next request.

listModelQualityJobDefinitionsResponse_httpStatus :: Lens' ListModelQualityJobDefinitionsResponse Int Source #

The response's http status code.

listModelQualityJobDefinitionsResponse_jobDefinitionSummaries :: Lens' ListModelQualityJobDefinitionsResponse [MonitoringJobDefinitionSummary] Source #

A list of summaries of model quality monitoring job definitions.

ListModels

listModels_creationTimeAfter :: Lens' ListModels (Maybe UTCTime) Source #

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

listModels_creationTimeBefore :: Lens' ListModels (Maybe UTCTime) Source #

A filter that returns only models created before the specified time (timestamp).

listModels_maxResults :: Lens' ListModels (Maybe Natural) Source #

The maximum number of models to return in the response.

listModels_nameContains :: Lens' ListModels (Maybe Text) Source #

A string in the model name. This filter returns only models whose name contains the specified string.

listModels_nextToken :: Lens' ListModels (Maybe Text) Source #

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.

listModels_sortBy :: Lens' ListModels (Maybe ModelSortKey) Source #

Sorts the list of results. The default is CreationTime.

listModels_sortOrder :: Lens' ListModels (Maybe OrderKey) Source #

The sort order for results. The default is Descending.

listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

listModelsResponse_httpStatus :: Lens' ListModelsResponse Int Source #

The response's http status code.

listModelsResponse_models :: Lens' ListModelsResponse [ModelSummary] Source #

An array of ModelSummary objects, each of which lists a model.

ListMonitoringAlertHistory

listMonitoringAlertHistory_creationTimeAfter :: Lens' ListMonitoringAlertHistory (Maybe UTCTime) Source #

A filter that returns only alerts created on or after the specified time.

listMonitoringAlertHistory_creationTimeBefore :: Lens' ListMonitoringAlertHistory (Maybe UTCTime) Source #

A filter that returns only alerts created on or before the specified time.

listMonitoringAlertHistory_maxResults :: Lens' ListMonitoringAlertHistory (Maybe Natural) Source #

The maximum number of results to display. The default is 100.

listMonitoringAlertHistory_monitoringAlertName :: Lens' ListMonitoringAlertHistory (Maybe Text) Source #

The name of a monitoring alert.

listMonitoringAlertHistory_monitoringScheduleName :: Lens' ListMonitoringAlertHistory (Maybe Text) Source #

The name of a monitoring schedule.

listMonitoringAlertHistory_nextToken :: Lens' ListMonitoringAlertHistory (Maybe Text) Source #

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.

listMonitoringAlertHistory_sortBy :: Lens' ListMonitoringAlertHistory (Maybe MonitoringAlertHistorySortKey) Source #

The field used to sort results. The default is CreationTime.

listMonitoringAlertHistory_sortOrder :: Lens' ListMonitoringAlertHistory (Maybe SortOrder) Source #

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

listMonitoringAlertHistory_statusEquals :: Lens' ListMonitoringAlertHistory (Maybe MonitoringAlertStatus) Source #

A filter that retrieves only alerts with a specific status.

listMonitoringAlertHistoryResponse_monitoringAlertHistory :: Lens' ListMonitoringAlertHistoryResponse (Maybe [MonitoringAlertHistorySummary]) Source #

An alert history for a model monitoring schedule.

listMonitoringAlertHistoryResponse_nextToken :: Lens' ListMonitoringAlertHistoryResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

listMonitoringAlertHistoryResponse_httpStatus :: Lens' ListMonitoringAlertHistoryResponse Int Source #

The response's http status code.

ListMonitoringAlerts

listMonitoringAlerts_maxResults :: Lens' ListMonitoringAlerts (Maybe Natural) Source #

The maximum number of results to display. The default is 100.

listMonitoringAlerts_nextToken :: Lens' ListMonitoringAlerts (Maybe Text) Source #

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.

listMonitoringAlerts_monitoringScheduleName :: Lens' ListMonitoringAlerts Text Source #

The name of a monitoring schedule.

listMonitoringAlertsResponse_monitoringAlertSummaries :: Lens' ListMonitoringAlertsResponse (Maybe (NonEmpty MonitoringAlertSummary)) Source #

A JSON array where each element is a summary for a monitoring alert.

listMonitoringAlertsResponse_nextToken :: Lens' ListMonitoringAlertsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

listMonitoringAlertsResponse_httpStatus :: Lens' ListMonitoringAlertsResponse Int Source #

The response's http status code.

ListMonitoringExecutions

listMonitoringExecutions_creationTimeAfter :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs created after a specified time.

listMonitoringExecutions_creationTimeBefore :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs created before a specified time.

listMonitoringExecutions_endpointName :: Lens' ListMonitoringExecutions (Maybe Text) Source #

Name of a specific endpoint to fetch jobs for.

listMonitoringExecutions_lastModifiedTimeAfter :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs modified before a specified time.

listMonitoringExecutions_lastModifiedTimeBefore :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

A filter that returns only jobs modified after a specified time.

listMonitoringExecutions_maxResults :: Lens' ListMonitoringExecutions (Maybe Natural) Source #

The maximum number of jobs to return in the response. The default value is 10.

listMonitoringExecutions_monitoringJobDefinitionName :: Lens' ListMonitoringExecutions (Maybe Text) Source #

Gets a list of the monitoring job runs of the specified monitoring job definitions.

listMonitoringExecutions_monitoringScheduleName :: Lens' ListMonitoringExecutions (Maybe Text) Source #

Name of a specific schedule to fetch jobs for.

listMonitoringExecutions_monitoringTypeEquals :: Lens' ListMonitoringExecutions (Maybe MonitoringType) Source #

A filter that returns only the monitoring job runs of the specified monitoring type.

listMonitoringExecutions_nextToken :: Lens' ListMonitoringExecutions (Maybe Text) Source #

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

listMonitoringExecutions_scheduledTimeAfter :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

Filter for jobs scheduled after a specified time.

listMonitoringExecutions_scheduledTimeBefore :: Lens' ListMonitoringExecutions (Maybe UTCTime) Source #

Filter for jobs scheduled before a specified time.

listMonitoringExecutions_sortBy :: Lens' ListMonitoringExecutions (Maybe MonitoringExecutionSortKey) Source #

Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.

listMonitoringExecutions_sortOrder :: Lens' ListMonitoringExecutions (Maybe SortOrder) Source #

Whether to sort the results in Ascending or Descending order. The default is Descending.

listMonitoringExecutions_statusEquals :: Lens' ListMonitoringExecutions (Maybe ExecutionStatus) Source #

A filter that retrieves only jobs with a specific status.

listMonitoringExecutionsResponse_nextToken :: Lens' ListMonitoringExecutionsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent reques

listMonitoringExecutionsResponse_httpStatus :: Lens' ListMonitoringExecutionsResponse Int Source #

The response's http status code.

listMonitoringExecutionsResponse_monitoringExecutionSummaries :: Lens' ListMonitoringExecutionsResponse [MonitoringExecutionSummary] Source #

A JSON array in which each element is a summary for a monitoring execution.

ListMonitoringSchedules

listMonitoringSchedules_creationTimeAfter :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules created after a specified time.

listMonitoringSchedules_creationTimeBefore :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules created before a specified time.

listMonitoringSchedules_endpointName :: Lens' ListMonitoringSchedules (Maybe Text) Source #

Name of a specific endpoint to fetch schedules for.

listMonitoringSchedules_lastModifiedTimeAfter :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules modified after a specified time.

listMonitoringSchedules_lastModifiedTimeBefore :: Lens' ListMonitoringSchedules (Maybe UTCTime) Source #

A filter that returns only monitoring schedules modified before a specified time.

listMonitoringSchedules_maxResults :: Lens' ListMonitoringSchedules (Maybe Natural) Source #

The maximum number of jobs to return in the response. The default value is 10.

listMonitoringSchedules_monitoringJobDefinitionName :: Lens' ListMonitoringSchedules (Maybe Text) Source #

Gets a list of the monitoring schedules for the specified monitoring job definition.

listMonitoringSchedules_monitoringTypeEquals :: Lens' ListMonitoringSchedules (Maybe MonitoringType) Source #

A filter that returns only the monitoring schedules for the specified monitoring type.

listMonitoringSchedules_nameContains :: Lens' ListMonitoringSchedules (Maybe Text) Source #

Filter for monitoring schedules whose name contains a specified string.

listMonitoringSchedules_nextToken :: Lens' ListMonitoringSchedules (Maybe Text) Source #

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

listMonitoringSchedules_sortBy :: Lens' ListMonitoringSchedules (Maybe MonitoringScheduleSortKey) Source #

Whether to sort results by Status, CreationTime, ScheduledTime field. The default is CreationTime.

listMonitoringSchedules_sortOrder :: Lens' ListMonitoringSchedules (Maybe SortOrder) Source #

Whether to sort the results in Ascending or Descending order. The default is Descending.

listMonitoringSchedules_statusEquals :: Lens' ListMonitoringSchedules (Maybe ScheduleStatus) Source #

A filter that returns only monitoring schedules modified before a specified time.

listMonitoringSchedulesResponse_nextToken :: Lens' ListMonitoringSchedulesResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

listMonitoringSchedulesResponse_httpStatus :: Lens' ListMonitoringSchedulesResponse Int Source #

The response's http status code.

listMonitoringSchedulesResponse_monitoringScheduleSummaries :: Lens' ListMonitoringSchedulesResponse [MonitoringScheduleSummary] Source #

A JSON array in which each element is a summary for a monitoring schedule.

ListNotebookInstanceLifecycleConfigs

listNotebookInstanceLifecycleConfigs_creationTimeAfter :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

listNotebookInstanceLifecycleConfigs_creationTimeBefore :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

listNotebookInstanceLifecycleConfigs_lastModifiedTimeAfter :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

listNotebookInstanceLifecycleConfigs_lastModifiedTimeBefore :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

listNotebookInstanceLifecycleConfigs_maxResults :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe Natural) Source #

The maximum number of lifecycle configurations to return in the response.

listNotebookInstanceLifecycleConfigs_nameContains :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe Text) Source #

A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

listNotebookInstanceLifecycleConfigs_nextToken :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe Text) Source #

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.

listNotebookInstanceLifecycleConfigs_sortBy :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe NotebookInstanceLifecycleConfigSortKey) Source #

Sorts the list of results. The default is CreationTime.

listNotebookInstanceLifecycleConfigs_sortOrder :: Lens' ListNotebookInstanceLifecycleConfigs (Maybe NotebookInstanceLifecycleConfigSortOrder) Source #

The sort order for results.

listNotebookInstanceLifecycleConfigsResponse_nextToken :: Lens' ListNotebookInstanceLifecycleConfigsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

listNotebookInstanceLifecycleConfigsResponse_notebookInstanceLifecycleConfigs :: Lens' ListNotebookInstanceLifecycleConfigsResponse (Maybe [NotebookInstanceLifecycleConfigSummary]) Source #

An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

listNotebookInstanceLifecycleConfigsResponse_httpStatus :: Lens' ListNotebookInstanceLifecycleConfigsResponse Int Source #

The response's http status code.

ListNotebookInstances

listNotebookInstances_additionalCodeRepositoryEquals :: Lens' ListNotebookInstances (Maybe Text) Source #

A filter that returns only notebook instances with associated with the specified git repository.

listNotebookInstances_creationTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

A filter that returns only notebook instances that were created after the specified time (timestamp).

listNotebookInstances_creationTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

A filter that returns only notebook instances that were created before the specified time (timestamp).

listNotebookInstances_defaultCodeRepositoryContains :: Lens' ListNotebookInstances (Maybe Text) Source #

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.

listNotebookInstances_lastModifiedTimeAfter :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

A filter that returns only notebook instances that were modified after the specified time (timestamp).

listNotebookInstances_lastModifiedTimeBefore :: Lens' ListNotebookInstances (Maybe UTCTime) Source #

A filter that returns only notebook instances that were modified before the specified time (timestamp).

listNotebookInstances_maxResults :: Lens' ListNotebookInstances (Maybe Natural) Source #

The maximum number of notebook instances to return.

listNotebookInstances_nameContains :: Lens' ListNotebookInstances (Maybe Text) Source #

A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

listNotebookInstances_nextToken :: Lens' ListNotebookInstances (Maybe Text) Source #

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.

listNotebookInstances_notebookInstanceLifecycleConfigNameContains :: Lens' ListNotebookInstances (Maybe Text) Source #

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.

listNotebookInstances_sortBy :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortKey) Source #

The field to sort results by. The default is Name.

listNotebookInstances_sortOrder :: Lens' ListNotebookInstances (Maybe NotebookInstanceSortOrder) Source #

The sort order for results.

listNotebookInstances_statusEquals :: Lens' ListNotebookInstances (Maybe NotebookInstanceStatus) Source #

A filter that returns only notebook instances with the specified status.

listNotebookInstancesResponse_nextToken :: Lens' ListNotebookInstancesResponse (Maybe Text) Source #

If the response to the previous ListNotebookInstances request was truncated, SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

listNotebookInstancesResponse_notebookInstances :: Lens' ListNotebookInstancesResponse (Maybe [NotebookInstanceSummary]) Source #

An array of NotebookInstanceSummary objects, one for each notebook instance.

listNotebookInstancesResponse_httpStatus :: Lens' ListNotebookInstancesResponse Int Source #

The response's http status code.

ListPipelineExecutionSteps

listPipelineExecutionSteps_maxResults :: Lens' ListPipelineExecutionSteps (Maybe Natural) Source #

The maximum number of pipeline execution steps to return in the response.

listPipelineExecutionSteps_nextToken :: Lens' ListPipelineExecutionSteps (Maybe Text) Source #

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.

listPipelineExecutionSteps_pipelineExecutionArn :: Lens' ListPipelineExecutionSteps (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

listPipelineExecutionSteps_sortOrder :: Lens' ListPipelineExecutionSteps (Maybe SortOrder) Source #

The field by which to sort results. The default is CreatedTime.

listPipelineExecutionStepsResponse_nextToken :: Lens' ListPipelineExecutionStepsResponse (Maybe Text) Source #

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.

listPipelineExecutionStepsResponse_pipelineExecutionSteps :: Lens' ListPipelineExecutionStepsResponse (Maybe [PipelineExecutionStep]) Source #

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.

listPipelineExecutionStepsResponse_httpStatus :: Lens' ListPipelineExecutionStepsResponse Int Source #

The response's http status code.

ListPipelineExecutions

listPipelineExecutions_createdAfter :: Lens' ListPipelineExecutions (Maybe UTCTime) Source #

A filter that returns the pipeline executions that were created after a specified time.

listPipelineExecutions_createdBefore :: Lens' ListPipelineExecutions (Maybe UTCTime) Source #

A filter that returns the pipeline executions that were created before a specified time.

listPipelineExecutions_maxResults :: Lens' ListPipelineExecutions (Maybe Natural) Source #

The maximum number of pipeline executions to return in the response.

listPipelineExecutions_nextToken :: Lens' ListPipelineExecutions (Maybe Text) Source #

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.

listPipelineExecutions_sortBy :: Lens' ListPipelineExecutions (Maybe SortPipelineExecutionsBy) Source #

The field by which to sort results. The default is CreatedTime.

listPipelineExecutions_sortOrder :: Lens' ListPipelineExecutions (Maybe SortOrder) Source #

The sort order for results.

listPipelineExecutions_pipelineName :: Lens' ListPipelineExecutions Text Source #

The name of the pipeline.

listPipelineExecutionsResponse_nextToken :: Lens' ListPipelineExecutionsResponse (Maybe Text) Source #

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.

listPipelineExecutionsResponse_pipelineExecutionSummaries :: Lens' ListPipelineExecutionsResponse (Maybe [PipelineExecutionSummary]) Source #

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.

listPipelineExecutionsResponse_httpStatus :: Lens' ListPipelineExecutionsResponse Int Source #

The response's http status code.

ListPipelineParametersForExecution

listPipelineParametersForExecution_maxResults :: Lens' ListPipelineParametersForExecution (Maybe Natural) Source #

The maximum number of parameters to return in the response.

listPipelineParametersForExecution_nextToken :: Lens' ListPipelineParametersForExecution (Maybe Text) Source #

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.

listPipelineParametersForExecution_pipelineExecutionArn :: Lens' ListPipelineParametersForExecution Text Source #

The Amazon Resource Name (ARN) of the pipeline execution.

listPipelineParametersForExecutionResponse_nextToken :: Lens' ListPipelineParametersForExecutionResponse (Maybe Text) Source #

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.

listPipelineParametersForExecutionResponse_pipelineParameters :: Lens' ListPipelineParametersForExecutionResponse (Maybe [Parameter]) Source #

Contains a list of pipeline parameters. This list can be empty.

listPipelineParametersForExecutionResponse_httpStatus :: Lens' ListPipelineParametersForExecutionResponse Int Source #

The response's http status code.

ListPipelines

listPipelines_createdAfter :: Lens' ListPipelines (Maybe UTCTime) Source #

A filter that returns the pipelines that were created after a specified time.

listPipelines_createdBefore :: Lens' ListPipelines (Maybe UTCTime) Source #

A filter that returns the pipelines that were created before a specified time.

listPipelines_maxResults :: Lens' ListPipelines (Maybe Natural) Source #

The maximum number of pipelines to return in the response.

listPipelines_nextToken :: Lens' ListPipelines (Maybe Text) Source #

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.

listPipelines_pipelineNamePrefix :: Lens' ListPipelines (Maybe Text) Source #

The prefix of the pipeline name.

listPipelines_sortBy :: Lens' ListPipelines (Maybe SortPipelinesBy) Source #

The field by which to sort results. The default is CreatedTime.

listPipelines_sortOrder :: Lens' ListPipelines (Maybe SortOrder) Source #

The sort order for results.

listPipelinesResponse_nextToken :: Lens' ListPipelinesResponse (Maybe Text) Source #

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.

listPipelinesResponse_pipelineSummaries :: Lens' ListPipelinesResponse (Maybe [PipelineSummary]) Source #

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.

listPipelinesResponse_httpStatus :: Lens' ListPipelinesResponse Int Source #

The response's http status code.

ListProcessingJobs

listProcessingJobs_creationTimeAfter :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs created after the specified time.

listProcessingJobs_creationTimeBefore :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs created after the specified time.

listProcessingJobs_lastModifiedTimeAfter :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs modified after the specified time.

listProcessingJobs_lastModifiedTimeBefore :: Lens' ListProcessingJobs (Maybe UTCTime) Source #

A filter that returns only processing jobs modified before the specified time.

listProcessingJobs_maxResults :: Lens' ListProcessingJobs (Maybe Natural) Source #

The maximum number of processing jobs to return in the response.

listProcessingJobs_nameContains :: Lens' ListProcessingJobs (Maybe Text) Source #

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

listProcessingJobs_nextToken :: Lens' ListProcessingJobs (Maybe Text) Source #

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.

listProcessingJobs_sortBy :: Lens' ListProcessingJobs (Maybe SortBy) Source #

The field to sort results by. The default is CreationTime.

listProcessingJobs_sortOrder :: Lens' ListProcessingJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listProcessingJobs_statusEquals :: Lens' ListProcessingJobs (Maybe ProcessingJobStatus) Source #

A filter that retrieves only processing jobs with a specific status.

listProcessingJobsResponse_nextToken :: Lens' ListProcessingJobsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

listProcessingJobsResponse_httpStatus :: Lens' ListProcessingJobsResponse Int Source #

The response's http status code.

listProcessingJobsResponse_processingJobSummaries :: Lens' ListProcessingJobsResponse [ProcessingJobSummary] Source #

An array of ProcessingJobSummary objects, each listing a processing job.

ListProjects

listProjects_creationTimeAfter :: Lens' ListProjects (Maybe UTCTime) Source #

A filter that returns the projects that were created after a specified time.

listProjects_creationTimeBefore :: Lens' ListProjects (Maybe UTCTime) Source #

A filter that returns the projects that were created before a specified time.

listProjects_maxResults :: Lens' ListProjects (Maybe Natural) Source #

The maximum number of projects to return in the response.

listProjects_nameContains :: Lens' ListProjects (Maybe Text) Source #

A filter that returns the projects whose name contains a specified string.

listProjects_nextToken :: Lens' ListProjects (Maybe Text) Source #

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.

listProjects_sortBy :: Lens' ListProjects (Maybe ProjectSortBy) Source #

The field by which to sort results. The default is CreationTime.

listProjects_sortOrder :: Lens' ListProjects (Maybe ProjectSortOrder) Source #

The sort order for results. The default is Ascending.

listProjectsResponse_nextToken :: Lens' ListProjectsResponse (Maybe Text) Source #

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.

listProjectsResponse_httpStatus :: Lens' ListProjectsResponse Int Source #

The response's http status code.

listProjectsResponse_projectSummaryList :: Lens' ListProjectsResponse [ProjectSummary] Source #

A list of summaries of projects.

ListSpaces

listSpaces_domainIdEquals :: Lens' ListSpaces (Maybe Text) Source #

A parameter to search for the Domain ID.

listSpaces_maxResults :: Lens' ListSpaces (Maybe Natural) Source #

Returns a list up to a specified limit.

listSpaces_nextToken :: Lens' ListSpaces (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listSpaces_sortBy :: Lens' ListSpaces (Maybe SpaceSortKey) Source #

The parameter by which to sort the results. The default is CreationTime.

listSpaces_sortOrder :: Lens' ListSpaces (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listSpaces_spaceNameContains :: Lens' ListSpaces (Maybe Text) Source #

A parameter by which to filter the results.

listSpacesResponse_nextToken :: Lens' ListSpacesResponse (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listSpacesResponse_spaces :: Lens' ListSpacesResponse (Maybe [SpaceDetails]) Source #

The list of spaces.

listSpacesResponse_httpStatus :: Lens' ListSpacesResponse Int Source #

The response's http status code.

ListStageDevices

listStageDevices_excludeDevicesDeployedInOtherStage :: Lens' ListStageDevices (Maybe Bool) Source #

Toggle for excluding devices deployed in other stages.

listStageDevices_maxResults :: Lens' ListStageDevices (Maybe Int) Source #

The maximum number of requests to select.

listStageDevices_nextToken :: Lens' ListStageDevices (Maybe Text) Source #

The response from the last list when returning a list large enough to neeed tokening.

listStageDevices_edgeDeploymentPlanName :: Lens' ListStageDevices Text Source #

The name of the edge deployment plan.

listStageDevices_stageName :: Lens' ListStageDevices Text Source #

The name of the stage in the deployment.

listStageDevicesResponse_nextToken :: Lens' ListStageDevicesResponse (Maybe Text) Source #

The token to use when calling the next page of results.

listStageDevicesResponse_httpStatus :: Lens' ListStageDevicesResponse Int Source #

The response's http status code.

listStageDevicesResponse_deviceDeploymentSummaries :: Lens' ListStageDevicesResponse [DeviceDeploymentSummary] Source #

List of summaries of devices allocated to the stage.

ListStudioLifecycleConfigs

listStudioLifecycleConfigs_appTypeEquals :: Lens' ListStudioLifecycleConfigs (Maybe StudioLifecycleConfigAppType) Source #

A parameter to search for the App Type to which the Lifecycle Configuration is attached.

listStudioLifecycleConfigs_creationTimeAfter :: Lens' ListStudioLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only Lifecycle Configurations created on or after the specified time.

listStudioLifecycleConfigs_creationTimeBefore :: Lens' ListStudioLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only Lifecycle Configurations created on or before the specified time.

listStudioLifecycleConfigs_maxResults :: Lens' ListStudioLifecycleConfigs (Maybe Natural) Source #

The maximum number of Studio Lifecycle Configurations to return in the response. The default value is 10.

listStudioLifecycleConfigs_modifiedTimeAfter :: Lens' ListStudioLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only Lifecycle Configurations modified after the specified time.

listStudioLifecycleConfigs_modifiedTimeBefore :: Lens' ListStudioLifecycleConfigs (Maybe UTCTime) Source #

A filter that returns only Lifecycle Configurations modified before the specified time.

listStudioLifecycleConfigs_nameContains :: Lens' ListStudioLifecycleConfigs (Maybe Text) Source #

A string in the Lifecycle Configuration name. This filter returns only Lifecycle Configurations whose name contains the specified string.

listStudioLifecycleConfigs_nextToken :: Lens' ListStudioLifecycleConfigs (Maybe Text) Source #

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.

listStudioLifecycleConfigs_sortBy :: Lens' ListStudioLifecycleConfigs (Maybe StudioLifecycleConfigSortKey) Source #

The property used to sort results. The default value is CreationTime.

listStudioLifecycleConfigs_sortOrder :: Lens' ListStudioLifecycleConfigs (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listStudioLifecycleConfigsResponse_nextToken :: Lens' ListStudioLifecycleConfigsResponse (Maybe Text) Source #

A token for getting the next set of actions, if there are any.

listStudioLifecycleConfigsResponse_studioLifecycleConfigs :: Lens' ListStudioLifecycleConfigsResponse (Maybe [StudioLifecycleConfigDetails]) Source #

A list of Lifecycle Configurations and their properties.

listStudioLifecycleConfigsResponse_httpStatus :: Lens' ListStudioLifecycleConfigsResponse Int Source #

The response's http status code.

ListSubscribedWorkteams

listSubscribedWorkteams_maxResults :: Lens' ListSubscribedWorkteams (Maybe Natural) Source #

The maximum number of work teams to return in each page of the response.

listSubscribedWorkteams_nameContains :: Lens' ListSubscribedWorkteams (Maybe Text) Source #

A string in the work team name. This filter returns only work teams whose name contains the specified string.

listSubscribedWorkteams_nextToken :: Lens' ListSubscribedWorkteams (Maybe Text) Source #

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.

listSubscribedWorkteamsResponse_nextToken :: Lens' ListSubscribedWorkteamsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

listSubscribedWorkteamsResponse_httpStatus :: Lens' ListSubscribedWorkteamsResponse Int Source #

The response's http status code.

listSubscribedWorkteamsResponse_subscribedWorkteams :: Lens' ListSubscribedWorkteamsResponse [SubscribedWorkteam] Source #

An array of Workteam objects, each describing a work team.

ListTags

listTags_maxResults :: Lens' ListTags (Maybe Natural) Source #

Maximum number of tags to return.

listTags_nextToken :: Lens' ListTags (Maybe Text) Source #

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.

listTags_resourceArn :: Lens' ListTags Text Source #

The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #

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.

listTagsResponse_tags :: Lens' ListTagsResponse (Maybe [Tag]) Source #

An array of Tag objects, each with a tag key and a value.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

ListTrainingJobs

listTrainingJobs_creationTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs created after the specified time (timestamp).

listTrainingJobs_creationTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs created before the specified time (timestamp).

listTrainingJobs_lastModifiedTimeAfter :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs modified after the specified time (timestamp).

listTrainingJobs_lastModifiedTimeBefore :: Lens' ListTrainingJobs (Maybe UTCTime) Source #

A filter that returns only training jobs modified before the specified time (timestamp).

listTrainingJobs_maxResults :: Lens' ListTrainingJobs (Maybe Natural) Source #

The maximum number of training jobs to return in the response.

listTrainingJobs_nameContains :: Lens' ListTrainingJobs (Maybe Text) Source #

A string in the training job name. This filter returns only training jobs whose name contains the specified string.

listTrainingJobs_nextToken :: Lens' ListTrainingJobs (Maybe Text) Source #

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.

listTrainingJobs_sortBy :: Lens' ListTrainingJobs (Maybe SortBy) Source #

The field to sort results by. The default is CreationTime.

listTrainingJobs_sortOrder :: Lens' ListTrainingJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listTrainingJobs_statusEquals :: Lens' ListTrainingJobs (Maybe TrainingJobStatus) Source #

A filter that retrieves only training jobs with a specific status.

listTrainingJobs_warmPoolStatusEquals :: Lens' ListTrainingJobs (Maybe WarmPoolResourceStatus) Source #

A filter that retrieves only training jobs with a specific warm pool status.

listTrainingJobsResponse_nextToken :: Lens' ListTrainingJobsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

listTrainingJobsResponse_httpStatus :: Lens' ListTrainingJobsResponse Int Source #

The response's http status code.

listTrainingJobsResponse_trainingJobSummaries :: Lens' ListTrainingJobsResponse [TrainingJobSummary] Source #

An array of TrainingJobSummary objects, each listing a training job.

ListTrainingJobsForHyperParameterTuningJob

listTrainingJobsForHyperParameterTuningJob_maxResults :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Natural) Source #

The maximum number of training jobs to return. The default value is 10.

listTrainingJobsForHyperParameterTuningJob_nextToken :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Text) Source #

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.

listTrainingJobsForHyperParameterTuningJob_sortBy :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe TrainingJobSortByOptions) Source #

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.

listTrainingJobsForHyperParameterTuningJob_sortOrder :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listTrainingJobsForHyperParameterTuningJob_statusEquals :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe TrainingJobStatus) Source #

A filter that returns only training jobs with the specified status.

listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' ListTrainingJobsForHyperParameterTuningJob Text Source #

The name of the tuning job whose training jobs you want to list.

listTrainingJobsForHyperParameterTuningJobResponse_nextToken :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse (Maybe Text) Source #

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.

listTrainingJobsForHyperParameterTuningJobResponse_httpStatus :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse Int Source #

The response's http status code.

listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse [HyperParameterTrainingJobSummary] Source #

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

ListTransformJobs

listTransformJobs_creationTimeAfter :: Lens' ListTransformJobs (Maybe UTCTime) Source #

A filter that returns only transform jobs created after the specified time.

listTransformJobs_creationTimeBefore :: Lens' ListTransformJobs (Maybe UTCTime) Source #

A filter that returns only transform jobs created before the specified time.

listTransformJobs_lastModifiedTimeAfter :: Lens' ListTransformJobs (Maybe UTCTime) Source #

A filter that returns only transform jobs modified after the specified time.

listTransformJobs_lastModifiedTimeBefore :: Lens' ListTransformJobs (Maybe UTCTime) Source #

A filter that returns only transform jobs modified before the specified time.

listTransformJobs_maxResults :: Lens' ListTransformJobs (Maybe Natural) Source #

The maximum number of transform jobs to return in the response. The default value is 10.

listTransformJobs_nameContains :: Lens' ListTransformJobs (Maybe Text) Source #

A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

listTransformJobs_nextToken :: Lens' ListTransformJobs (Maybe Text) Source #

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.

listTransformJobs_sortBy :: Lens' ListTransformJobs (Maybe SortBy) Source #

The field to sort results by. The default is CreationTime.

listTransformJobs_sortOrder :: Lens' ListTransformJobs (Maybe SortOrder) Source #

The sort order for results. The default is Descending.

listTransformJobs_statusEquals :: Lens' ListTransformJobs (Maybe TransformJobStatus) Source #

A filter that retrieves only transform jobs with a specific status.

listTransformJobsResponse_nextToken :: Lens' ListTransformJobsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

listTransformJobsResponse_httpStatus :: Lens' ListTransformJobsResponse Int Source #

The response's http status code.

listTransformJobsResponse_transformJobSummaries :: Lens' ListTransformJobsResponse [TransformJobSummary] Source #

An array of TransformJobSummary objects.

ListTrialComponents

listTrialComponents_createdAfter :: Lens' ListTrialComponents (Maybe UTCTime) Source #

A filter that returns only components created after the specified time.

listTrialComponents_createdBefore :: Lens' ListTrialComponents (Maybe UTCTime) Source #

A filter that returns only components created before the specified time.

listTrialComponents_experimentName :: Lens' ListTrialComponents (Maybe Text) Source #

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.

listTrialComponents_maxResults :: Lens' ListTrialComponents (Maybe Natural) Source #

The maximum number of components to return in the response. The default value is 10.

listTrialComponents_nextToken :: Lens' ListTrialComponents (Maybe Text) Source #

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.

listTrialComponents_sortBy :: Lens' ListTrialComponents (Maybe SortTrialComponentsBy) Source #

The property used to sort results. The default value is CreationTime.

listTrialComponents_sortOrder :: Lens' ListTrialComponents (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listTrialComponents_sourceArn :: Lens' ListTrialComponents (Maybe Text) Source #

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.

listTrialComponents_trialName :: Lens' ListTrialComponents (Maybe Text) Source #

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.

listTrialComponentsResponse_nextToken :: Lens' ListTrialComponentsResponse (Maybe Text) Source #

A token for getting the next set of components, if there are any.

listTrialComponentsResponse_trialComponentSummaries :: Lens' ListTrialComponentsResponse (Maybe [TrialComponentSummary]) Source #

A list of the summaries of your trial components.

listTrialComponentsResponse_httpStatus :: Lens' ListTrialComponentsResponse Int Source #

The response's http status code.

ListTrials

listTrials_createdAfter :: Lens' ListTrials (Maybe UTCTime) Source #

A filter that returns only trials created after the specified time.

listTrials_createdBefore :: Lens' ListTrials (Maybe UTCTime) Source #

A filter that returns only trials created before the specified time.

listTrials_experimentName :: Lens' ListTrials (Maybe Text) Source #

A filter that returns only trials that are part of the specified experiment.

listTrials_maxResults :: Lens' ListTrials (Maybe Natural) Source #

The maximum number of trials to return in the response. The default value is 10.

listTrials_nextToken :: Lens' ListTrials (Maybe Text) Source #

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.

listTrials_sortBy :: Lens' ListTrials (Maybe SortTrialsBy) Source #

The property used to sort results. The default value is CreationTime.

listTrials_sortOrder :: Lens' ListTrials (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listTrials_trialComponentName :: Lens' ListTrials (Maybe Text) Source #

A filter that returns only trials that are associated with the specified trial component.

listTrialsResponse_nextToken :: Lens' ListTrialsResponse (Maybe Text) Source #

A token for getting the next set of trials, if there are any.

listTrialsResponse_trialSummaries :: Lens' ListTrialsResponse (Maybe [TrialSummary]) Source #

A list of the summaries of your trials.

listTrialsResponse_httpStatus :: Lens' ListTrialsResponse Int Source #

The response's http status code.

ListUserProfiles

listUserProfiles_domainIdEquals :: Lens' ListUserProfiles (Maybe Text) Source #

A parameter by which to filter the results.

listUserProfiles_maxResults :: Lens' ListUserProfiles (Maybe Natural) Source #

Returns a list up to a specified limit.

listUserProfiles_nextToken :: Lens' ListUserProfiles (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listUserProfiles_sortBy :: Lens' ListUserProfiles (Maybe UserProfileSortKey) Source #

The parameter by which to sort the results. The default is CreationTime.

listUserProfiles_sortOrder :: Lens' ListUserProfiles (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listUserProfiles_userProfileNameContains :: Lens' ListUserProfiles (Maybe Text) Source #

A parameter by which to filter the results.

listUserProfilesResponse_nextToken :: Lens' ListUserProfilesResponse (Maybe Text) Source #

If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.

listUserProfilesResponse_userProfiles :: Lens' ListUserProfilesResponse (Maybe [UserProfileDetails]) Source #

The list of user profiles.

listUserProfilesResponse_httpStatus :: Lens' ListUserProfilesResponse Int Source #

The response's http status code.

ListWorkforces

listWorkforces_maxResults :: Lens' ListWorkforces (Maybe Natural) Source #

The maximum number of workforces returned in the response.

listWorkforces_nameContains :: Lens' ListWorkforces (Maybe Text) Source #

A filter you can use to search for workforces using part of the workforce name.

listWorkforces_nextToken :: Lens' ListWorkforces (Maybe Text) Source #

A token to resume pagination.

listWorkforces_sortBy :: Lens' ListWorkforces (Maybe ListWorkforcesSortByOptions) Source #

Sort workforces using the workforce name or creation date.

listWorkforces_sortOrder :: Lens' ListWorkforces (Maybe SortOrder) Source #

Sort workforces in ascending or descending order.

listWorkforcesResponse_nextToken :: Lens' ListWorkforcesResponse (Maybe Text) Source #

A token to resume pagination.

listWorkforcesResponse_httpStatus :: Lens' ListWorkforcesResponse Int Source #

The response's http status code.

listWorkforcesResponse_workforces :: Lens' ListWorkforcesResponse [Workforce] Source #

A list containing information about your workforce.

ListWorkteams

listWorkteams_maxResults :: Lens' ListWorkteams (Maybe Natural) Source #

The maximum number of work teams to return in each page of the response.

listWorkteams_nameContains :: Lens' ListWorkteams (Maybe Text) Source #

A string in the work team's name. This filter returns only work teams whose name contains the specified string.

listWorkteams_nextToken :: Lens' ListWorkteams (Maybe Text) Source #

If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

listWorkteams_sortBy :: Lens' ListWorkteams (Maybe ListWorkteamsSortByOptions) Source #

The field to sort results by. The default is CreationTime.

listWorkteams_sortOrder :: Lens' ListWorkteams (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listWorkteamsResponse_nextToken :: Lens' ListWorkteamsResponse (Maybe Text) Source #

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

listWorkteamsResponse_httpStatus :: Lens' ListWorkteamsResponse Int Source #

The response's http status code.

listWorkteamsResponse_workteams :: Lens' ListWorkteamsResponse [Workteam] Source #

An array of Workteam objects, each describing a work team.

PutModelPackageGroupPolicy

putModelPackageGroupPolicy_modelPackageGroupName :: Lens' PutModelPackageGroupPolicy Text Source #

The name of the model group to add a resource policy to.

putModelPackageGroupPolicy_resourcePolicy :: Lens' PutModelPackageGroupPolicy Text Source #

The resource policy for the model group.

putModelPackageGroupPolicyResponse_httpStatus :: Lens' PutModelPackageGroupPolicyResponse Int Source #

The response's http status code.

putModelPackageGroupPolicyResponse_modelPackageGroupArn :: Lens' PutModelPackageGroupPolicyResponse Text Source #

The Amazon Resource Name (ARN) of the model package group.

QueryLineage

queryLineage_direction :: Lens' QueryLineage (Maybe Direction) Source #

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

queryLineage_filters :: Lens' QueryLineage (Maybe QueryFilters) Source #

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities' properties.
  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.
  • CreatedBefore - Filter entities created before this date.
  • ModifiedBefore - Filter entities modified before this date.
  • ModifiedAfter - Filter entities modified after this date.

queryLineage_includeEdges :: Lens' QueryLineage (Maybe Bool) Source #

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

queryLineage_maxDepth :: Lens' QueryLineage (Maybe Int) Source #

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

queryLineage_maxResults :: Lens' QueryLineage (Maybe Int) Source #

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

queryLineage_nextToken :: Lens' QueryLineage (Maybe Text) Source #

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

queryLineage_startArns :: Lens' QueryLineage (Maybe [Text]) Source #

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

queryLineageResponse_edges :: Lens' QueryLineageResponse (Maybe [Edge]) Source #

A list of edges that connect vertices in the response.

queryLineageResponse_nextToken :: Lens' QueryLineageResponse (Maybe Text) Source #

Limits the number of vertices in the response. Use the NextToken in a response to to retrieve the next page of results.

queryLineageResponse_vertices :: Lens' QueryLineageResponse (Maybe [Vertex]) Source #

A list of vertices connected to the start entity(ies) in the lineage graph.

queryLineageResponse_httpStatus :: Lens' QueryLineageResponse Int Source #

The response's http status code.

RegisterDevices

registerDevices_tags :: Lens' RegisterDevices (Maybe [Tag]) Source #

The tags associated with devices.

registerDevices_deviceFleetName :: Lens' RegisterDevices Text Source #

The name of the fleet.

registerDevices_devices :: Lens' RegisterDevices [Device] Source #

A list of devices to register with SageMaker Edge Manager.

RenderUiTemplate

renderUiTemplate_humanTaskUiArn :: Lens' RenderUiTemplate (Maybe Text) Source #

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

renderUiTemplate_uiTemplate :: Lens' RenderUiTemplate (Maybe UiTemplate) Source #

A Template object containing the worker UI template to render.

renderUiTemplate_task :: Lens' RenderUiTemplate RenderableTask Source #

A RenderableTask object containing a representative task to render.

renderUiTemplate_roleArn :: Lens' RenderUiTemplate Text Source #

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

renderUiTemplateResponse_httpStatus :: Lens' RenderUiTemplateResponse Int Source #

The response's http status code.

renderUiTemplateResponse_renderedContent :: Lens' RenderUiTemplateResponse Text Source #

A Liquid template that renders the HTML for the worker UI.

renderUiTemplateResponse_errors :: Lens' RenderUiTemplateResponse [RenderingError] Source #

A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

RetryPipelineExecution

retryPipelineExecution_parallelismConfiguration :: Lens' RetryPipelineExecution (Maybe ParallelismConfiguration) Source #

This configuration, if specified, overrides the parallelism configuration of the parent pipeline.

retryPipelineExecution_pipelineExecutionArn :: Lens' RetryPipelineExecution Text Source #

The Amazon Resource Name (ARN) of the pipeline execution.

retryPipelineExecution_clientRequestToken :: Lens' RetryPipelineExecution Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

retryPipelineExecutionResponse_pipelineExecutionArn :: Lens' RetryPipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

retryPipelineExecutionResponse_httpStatus :: Lens' RetryPipelineExecutionResponse Int Source #

The response's http status code.

Search

search_maxResults :: Lens' Search (Maybe Natural) Source #

The maximum number of results to return.

search_nextToken :: Lens' Search (Maybe Text) Source #

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

search_searchExpression :: Lens' Search (Maybe SearchExpression) Source #

A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

search_sortBy :: Lens' Search (Maybe Text) Source #

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

search_sortOrder :: Lens' Search (Maybe SearchSortOrder) Source #

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

search_resource :: Lens' Search ResourceType Source #

The name of the Amazon SageMaker resource to search for.

searchResponse_nextToken :: Lens' SearchResponse (Maybe Text) Source #

If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

searchResponse_results :: Lens' SearchResponse (Maybe [SearchRecord]) Source #

A list of SearchRecord objects.

searchResponse_httpStatus :: Lens' SearchResponse Int Source #

The response's http status code.

SendPipelineExecutionStepFailure

sendPipelineExecutionStepFailure_clientRequestToken :: Lens' SendPipelineExecutionStepFailure (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

sendPipelineExecutionStepFailure_failureReason :: Lens' SendPipelineExecutionStepFailure (Maybe Text) Source #

A message describing why the step failed.

sendPipelineExecutionStepFailure_callbackToken :: Lens' SendPipelineExecutionStepFailure Text Source #

The pipeline generated token from the Amazon SQS queue.

sendPipelineExecutionStepFailureResponse_pipelineExecutionArn :: Lens' SendPipelineExecutionStepFailureResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

sendPipelineExecutionStepFailureResponse_httpStatus :: Lens' SendPipelineExecutionStepFailureResponse Int Source #

The response's http status code.

SendPipelineExecutionStepSuccess

sendPipelineExecutionStepSuccess_clientRequestToken :: Lens' SendPipelineExecutionStepSuccess (Maybe Text) Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time.

sendPipelineExecutionStepSuccess_outputParameters :: Lens' SendPipelineExecutionStepSuccess (Maybe [OutputParameter]) Source #

A list of the output parameters of the callback step.

sendPipelineExecutionStepSuccess_callbackToken :: Lens' SendPipelineExecutionStepSuccess Text Source #

The pipeline generated token from the Amazon SQS queue.

sendPipelineExecutionStepSuccessResponse_pipelineExecutionArn :: Lens' SendPipelineExecutionStepSuccessResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

sendPipelineExecutionStepSuccessResponse_httpStatus :: Lens' SendPipelineExecutionStepSuccessResponse Int Source #

The response's http status code.

StartEdgeDeploymentStage

startEdgeDeploymentStage_edgeDeploymentPlanName :: Lens' StartEdgeDeploymentStage Text Source #

The name of the edge deployment plan to start.

startEdgeDeploymentStage_stageName :: Lens' StartEdgeDeploymentStage Text Source #

The name of the stage to start.

StartInferenceExperiment

startInferenceExperiment_name :: Lens' StartInferenceExperiment Text Source #

The name of the inference experiment to start.

startInferenceExperimentResponse_httpStatus :: Lens' StartInferenceExperimentResponse Int Source #

The response's http status code.

startInferenceExperimentResponse_inferenceExperimentArn :: Lens' StartInferenceExperimentResponse Text Source #

The ARN of the started inference experiment to start.

StartMonitoringSchedule

startMonitoringSchedule_monitoringScheduleName :: Lens' StartMonitoringSchedule Text Source #

The name of the schedule to start.

StartNotebookInstance

startNotebookInstance_notebookInstanceName :: Lens' StartNotebookInstance Text Source #

The name of the notebook instance to start.

StartPipelineExecution

startPipelineExecution_parallelismConfiguration :: Lens' StartPipelineExecution (Maybe ParallelismConfiguration) Source #

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

startPipelineExecution_pipelineExecutionDescription :: Lens' StartPipelineExecution (Maybe Text) Source #

The description of the pipeline execution.

startPipelineExecution_pipelineExecutionDisplayName :: Lens' StartPipelineExecution (Maybe Text) Source #

The display name of the pipeline execution.

startPipelineExecution_pipelineParameters :: Lens' StartPipelineExecution (Maybe [Parameter]) Source #

Contains a list of pipeline parameters. This list can be empty.

startPipelineExecution_pipelineName :: Lens' StartPipelineExecution Text Source #

The name of the pipeline.

startPipelineExecution_clientRequestToken :: Lens' StartPipelineExecution Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

startPipelineExecutionResponse_pipelineExecutionArn :: Lens' StartPipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

startPipelineExecutionResponse_httpStatus :: Lens' StartPipelineExecutionResponse Int Source #

The response's http status code.

StopAutoMLJob

stopAutoMLJob_autoMLJobName :: Lens' StopAutoMLJob Text Source #

The name of the object you are requesting.

StopCompilationJob

stopCompilationJob_compilationJobName :: Lens' StopCompilationJob Text Source #

The name of the model compilation job to stop.

StopEdgeDeploymentStage

stopEdgeDeploymentStage_edgeDeploymentPlanName :: Lens' StopEdgeDeploymentStage Text Source #

The name of the edge deployment plan to stop.

stopEdgeDeploymentStage_stageName :: Lens' StopEdgeDeploymentStage Text Source #

The name of the stage to stop.

StopEdgePackagingJob

stopEdgePackagingJob_edgePackagingJobName :: Lens' StopEdgePackagingJob Text Source #

The name of the edge packaging job.

StopHyperParameterTuningJob

stopHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' StopHyperParameterTuningJob Text Source #

The name of the tuning job to stop.

StopInferenceExperiment

stopInferenceExperiment_desiredModelVariants :: Lens' StopInferenceExperiment (Maybe (NonEmpty ModelVariantConfig)) Source #

An array of ModelVariantConfig objects. There is one for each variant that you want to deploy after the inference experiment stops. Each ModelVariantConfig describes the infrastructure configuration for deploying the corresponding variant.

stopInferenceExperiment_desiredState :: Lens' StopInferenceExperiment (Maybe InferenceExperimentStopDesiredState) Source #

The desired state of the experiment after stopping. The possible states are the following:

  • Completed: The experiment completed successfully
  • Cancelled: The experiment was canceled

stopInferenceExperiment_reason :: Lens' StopInferenceExperiment (Maybe Text) Source #

The reason for stopping the experiment.

stopInferenceExperiment_name :: Lens' StopInferenceExperiment Text Source #

The name of the inference experiment to stop.

stopInferenceExperiment_modelVariantActions :: Lens' StopInferenceExperiment (HashMap Text ModelVariantAction) Source #

Array of key-value pairs, with names of variants mapped to actions. The possible actions are the following:

  • Promote - Promote the shadow variant to a production variant
  • Remove - Delete the variant
  • Retain - Keep the variant as it is

stopInferenceExperimentResponse_httpStatus :: Lens' StopInferenceExperimentResponse Int Source #

The response's http status code.

stopInferenceExperimentResponse_inferenceExperimentArn :: Lens' StopInferenceExperimentResponse Text Source #

The ARN of the stopped inference experiment.

StopInferenceRecommendationsJob

stopInferenceRecommendationsJob_jobName :: Lens' StopInferenceRecommendationsJob Text Source #

The name of the job you want to stop.

StopLabelingJob

stopLabelingJob_labelingJobName :: Lens' StopLabelingJob Text Source #

The name of the labeling job to stop.

StopMonitoringSchedule

stopMonitoringSchedule_monitoringScheduleName :: Lens' StopMonitoringSchedule Text Source #

The name of the schedule to stop.

StopNotebookInstance

stopNotebookInstance_notebookInstanceName :: Lens' StopNotebookInstance Text Source #

The name of the notebook instance to terminate.

StopPipelineExecution

stopPipelineExecution_pipelineExecutionArn :: Lens' StopPipelineExecution Text Source #

The Amazon Resource Name (ARN) of the pipeline execution.

stopPipelineExecution_clientRequestToken :: Lens' StopPipelineExecution Text Source #

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.

stopPipelineExecutionResponse_pipelineExecutionArn :: Lens' StopPipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int Source #

The response's http status code.

StopProcessingJob

stopProcessingJob_processingJobName :: Lens' StopProcessingJob Text Source #

The name of the processing job to stop.

StopTrainingJob

stopTrainingJob_trainingJobName :: Lens' StopTrainingJob Text Source #

The name of the training job to stop.

StopTransformJob

stopTransformJob_transformJobName :: Lens' StopTransformJob Text Source #

The name of the batch transform job to stop.

UpdateAction

updateAction_description :: Lens' UpdateAction (Maybe Text) Source #

The new description for the action.

updateAction_properties :: Lens' UpdateAction (Maybe (HashMap Text Text)) Source #

The new list of properties. Overwrites the current property list.

updateAction_propertiesToRemove :: Lens' UpdateAction (Maybe [Text]) Source #

A list of properties to remove.

updateAction_status :: Lens' UpdateAction (Maybe ActionStatus) Source #

The new status for the action.

updateAction_actionName :: Lens' UpdateAction Text Source #

The name of the action to update.

updateActionResponse_actionArn :: Lens' UpdateActionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the action.

updateActionResponse_httpStatus :: Lens' UpdateActionResponse Int Source #

The response's http status code.

UpdateAppImageConfig

updateAppImageConfig_kernelGatewayImageConfig :: Lens' UpdateAppImageConfig (Maybe KernelGatewayImageConfig) Source #

The new KernelGateway app to run on the image.

updateAppImageConfig_appImageConfigName :: Lens' UpdateAppImageConfig Text Source #

The name of the AppImageConfig to update.

updateAppImageConfigResponse_appImageConfigArn :: Lens' UpdateAppImageConfigResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the AppImageConfig.

updateAppImageConfigResponse_httpStatus :: Lens' UpdateAppImageConfigResponse Int Source #

The response's http status code.

UpdateArtifact

updateArtifact_artifactName :: Lens' UpdateArtifact (Maybe Text) Source #

The new name for the artifact.

updateArtifact_properties :: Lens' UpdateArtifact (Maybe (HashMap Text Text)) Source #

The new list of properties. Overwrites the current property list.

updateArtifact_propertiesToRemove :: Lens' UpdateArtifact (Maybe [Text]) Source #

A list of properties to remove.

updateArtifact_artifactArn :: Lens' UpdateArtifact Text Source #

The Amazon Resource Name (ARN) of the artifact to update.

updateArtifactResponse_artifactArn :: Lens' UpdateArtifactResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact.

updateArtifactResponse_httpStatus :: Lens' UpdateArtifactResponse Int Source #

The response's http status code.

UpdateCodeRepository

updateCodeRepository_gitConfig :: Lens' UpdateCodeRepository (Maybe GitConfigForUpdate) Source #

The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

updateCodeRepository_codeRepositoryName :: Lens' UpdateCodeRepository Text Source #

The name of the Git repository to update.

updateCodeRepositoryResponse_httpStatus :: Lens' UpdateCodeRepositoryResponse Int Source #

The response's http status code.

updateCodeRepositoryResponse_codeRepositoryArn :: Lens' UpdateCodeRepositoryResponse Text Source #

The ARN of the Git repository.

UpdateContext

updateContext_description :: Lens' UpdateContext (Maybe Text) Source #

The new description for the context.

updateContext_properties :: Lens' UpdateContext (Maybe (HashMap Text Text)) Source #

The new list of properties. Overwrites the current property list.

updateContext_propertiesToRemove :: Lens' UpdateContext (Maybe [Text]) Source #

A list of properties to remove.

updateContext_contextName :: Lens' UpdateContext Text Source #

The name of the context to update.

updateContextResponse_contextArn :: Lens' UpdateContextResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the context.

updateContextResponse_httpStatus :: Lens' UpdateContextResponse Int Source #

The response's http status code.

UpdateDeviceFleet

updateDeviceFleet_description :: Lens' UpdateDeviceFleet (Maybe Text) Source #

Description of the fleet.

updateDeviceFleet_enableIotRoleAlias :: Lens' UpdateDeviceFleet (Maybe Bool) Source #

Whether to create an Amazon Web Services IoT Role Alias during device fleet creation. The name of the role alias generated will match this pattern: "SageMakerEdge-{DeviceFleetName}".

For example, if your device fleet is called "demo-fleet", the name of the role alias will be "SageMakerEdge-demo-fleet".

updateDeviceFleet_roleArn :: Lens' UpdateDeviceFleet (Maybe Text) Source #

The Amazon Resource Name (ARN) of the device.

updateDeviceFleet_deviceFleetName :: Lens' UpdateDeviceFleet Text Source #

The name of the fleet.

updateDeviceFleet_outputConfig :: Lens' UpdateDeviceFleet EdgeOutputConfig Source #

Output configuration for storing sample data collected by the fleet.

UpdateDevices

updateDevices_deviceFleetName :: Lens' UpdateDevices Text Source #

The name of the fleet the devices belong to.

updateDevices_devices :: Lens' UpdateDevices [Device] Source #

List of devices to register with Edge Manager agent.

UpdateDomain

updateDomain_appSecurityGroupManagement :: Lens' UpdateDomain (Maybe AppSecurityGroupManagement) Source #

The entity that creates and manages the required security groups for inter-app communication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType is VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn is provided.

updateDomain_defaultSpaceSettings :: Lens' UpdateDomain (Maybe DefaultSpaceSettings) Source #

The default settings used to create a space within the Domain.

updateDomain_defaultUserSettings :: Lens' UpdateDomain (Maybe UserSettings) Source #

A collection of settings.

updateDomain_domainSettingsForUpdate :: Lens' UpdateDomain (Maybe DomainSettingsForUpdate) Source #

A collection of DomainSettings configuration values to update.

updateDomain_domainId :: Lens' UpdateDomain Text Source #

The ID of the domain to be updated.

updateDomainResponse_domainArn :: Lens' UpdateDomainResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the domain.

updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int Source #

The response's http status code.

UpdateEndpoint

updateEndpoint_deploymentConfig :: Lens' UpdateEndpoint (Maybe DeploymentConfig) Source #

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

updateEndpoint_excludeRetainedVariantProperties :: Lens' UpdateEndpoint (Maybe [VariantProperty]) Source #

When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties, no variant properties are overridden.

updateEndpoint_retainAllVariantProperties :: Lens' UpdateEndpoint (Maybe Bool) Source #

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

updateEndpoint_retainDeploymentConfig :: Lens' UpdateEndpoint (Maybe Bool) Source #

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

updateEndpoint_endpointName :: Lens' UpdateEndpoint Text Source #

The name of the endpoint whose configuration you want to update.

updateEndpoint_endpointConfigName :: Lens' UpdateEndpoint Text Source #

The name of the new endpoint configuration.

updateEndpointResponse_httpStatus :: Lens' UpdateEndpointResponse Int Source #

The response's http status code.

updateEndpointResponse_endpointArn :: Lens' UpdateEndpointResponse Text Source #

The Amazon Resource Name (ARN) of the endpoint.

UpdateEndpointWeightsAndCapacities

updateEndpointWeightsAndCapacities_endpointName :: Lens' UpdateEndpointWeightsAndCapacities Text Source #

The name of an existing SageMaker endpoint.

updateEndpointWeightsAndCapacities_desiredWeightsAndCapacities :: Lens' UpdateEndpointWeightsAndCapacities (NonEmpty DesiredWeightAndCapacity) Source #

An object that provides new capacity and weight values for a variant.

updateEndpointWeightsAndCapacitiesResponse_httpStatus :: Lens' UpdateEndpointWeightsAndCapacitiesResponse Int Source #

The response's http status code.

updateEndpointWeightsAndCapacitiesResponse_endpointArn :: Lens' UpdateEndpointWeightsAndCapacitiesResponse Text Source #

The Amazon Resource Name (ARN) of the updated endpoint.

UpdateExperiment

updateExperiment_description :: Lens' UpdateExperiment (Maybe Text) Source #

The description of the experiment.

updateExperiment_displayName :: Lens' UpdateExperiment (Maybe Text) Source #

The name of the experiment as displayed. The name doesn't need to be unique. If DisplayName isn't specified, ExperimentName is displayed.

updateExperiment_experimentName :: Lens' UpdateExperiment Text Source #

The name of the experiment to update.

updateExperimentResponse_experimentArn :: Lens' UpdateExperimentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

updateExperimentResponse_httpStatus :: Lens' UpdateExperimentResponse Int Source #

The response's http status code.

UpdateFeatureGroup

updateFeatureGroup_featureAdditions :: Lens' UpdateFeatureGroup (Maybe (NonEmpty FeatureDefinition)) Source #

Updates the feature group. Updating a feature group is an asynchronous operation. When you get an HTTP 200 response, you've made a valid request. It takes some time after you've made a valid request for Feature Store to update the feature group.

updateFeatureGroup_featureGroupName :: Lens' UpdateFeatureGroup Text Source #

The name of the feature group that you're updating.

updateFeatureGroupResponse_httpStatus :: Lens' UpdateFeatureGroupResponse Int Source #

The response's http status code.

updateFeatureGroupResponse_featureGroupArn :: Lens' UpdateFeatureGroupResponse Text Source #

The Amazon Resource Number (ARN) of the feature group that you're updating.

UpdateFeatureMetadata

updateFeatureMetadata_description :: Lens' UpdateFeatureMetadata (Maybe Text) Source #

A description that you can write to better describe the feature.

updateFeatureMetadata_parameterAdditions :: Lens' UpdateFeatureMetadata (Maybe [FeatureParameter]) Source #

A list of key-value pairs that you can add to better describe the feature.

updateFeatureMetadata_parameterRemovals :: Lens' UpdateFeatureMetadata (Maybe [Text]) Source #

A list of parameter keys that you can specify to remove parameters that describe your feature.

updateFeatureMetadata_featureGroupName :: Lens' UpdateFeatureMetadata Text Source #

The name of the feature group containing the feature that you're updating.

updateFeatureMetadata_featureName :: Lens' UpdateFeatureMetadata Text Source #

The name of the feature that you're updating.

UpdateHub

updateHub_hubDescription :: Lens' UpdateHub (Maybe Text) Source #

A description of the updated hub.

updateHub_hubDisplayName :: Lens' UpdateHub (Maybe Text) Source #

The display name of the hub.

updateHub_hubSearchKeywords :: Lens' UpdateHub (Maybe [Text]) Source #

The searchable keywords for the hub.

updateHub_hubName :: Lens' UpdateHub Text Source #

The name of the hub to update.

updateHubResponse_httpStatus :: Lens' UpdateHubResponse Int Source #

The response's http status code.

updateHubResponse_hubArn :: Lens' UpdateHubResponse Text Source #

The Amazon Resource Name (ARN) of the updated hub.

UpdateImage

updateImage_deleteProperties :: Lens' UpdateImage (Maybe [Text]) Source #

A list of properties to delete. Only the Description and DisplayName properties can be deleted.

updateImage_description :: Lens' UpdateImage (Maybe Text) Source #

The new description for the image.

updateImage_displayName :: Lens' UpdateImage (Maybe Text) Source #

The new display name for the image.

updateImage_roleArn :: Lens' UpdateImage (Maybe Text) Source #

The new ARN for the IAM role that enables Amazon SageMaker to perform tasks on your behalf.

updateImage_imageName :: Lens' UpdateImage Text Source #

The name of the image to update.

updateImageResponse_imageArn :: Lens' UpdateImageResponse (Maybe Text) Source #

The ARN of the image.

updateImageResponse_httpStatus :: Lens' UpdateImageResponse Int Source #

The response's http status code.

UpdateImageVersion

updateImageVersion_alias :: Lens' UpdateImageVersion (Maybe Text) Source #

The alias of the image version.

updateImageVersion_aliasesToAdd :: Lens' UpdateImageVersion (Maybe [Text]) Source #

A list of aliases to add.

updateImageVersion_aliasesToDelete :: Lens' UpdateImageVersion (Maybe [Text]) Source #

A list of aliases to delete.

updateImageVersion_horovod :: Lens' UpdateImageVersion (Maybe Bool) Source #

Indicates Horovod compatibility.

updateImageVersion_jobType :: Lens' UpdateImageVersion (Maybe JobType) Source #

Indicates SageMaker job type compatibility.

  • TRAINING: The image version is compatible with SageMaker training jobs.
  • INFERENCE: The image version is compatible with SageMaker inference jobs.
  • NOTEBOOK_KERNEL: The image version is compatible with SageMaker notebook kernels.

updateImageVersion_mLFramework :: Lens' UpdateImageVersion (Maybe Text) Source #

The machine learning framework vended in the image version.

updateImageVersion_processor :: Lens' UpdateImageVersion (Maybe Processor) Source #

Indicates CPU or GPU compatibility.

  • CPU: The image version is compatible with CPU.
  • GPU: The image version is compatible with GPU.

updateImageVersion_programmingLang :: Lens' UpdateImageVersion (Maybe Text) Source #

The supported programming language and its version.

updateImageVersion_releaseNotes :: Lens' UpdateImageVersion (Maybe Text) Source #

The maintainer description of the image version.

updateImageVersion_vendorGuidance :: Lens' UpdateImageVersion (Maybe VendorGuidance) Source #

The availability of the image version specified by the maintainer.

  • NOT_PROVIDED: The maintainers did not provide a status for image version stability.
  • STABLE: The image version is stable.
  • TO_BE_ARCHIVED: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.
  • ARCHIVED: The image version is archived. Archived image versions are not searchable and are no longer actively supported.

updateImageVersion_version :: Lens' UpdateImageVersion (Maybe Natural) Source #

The version of the image.

updateImageVersion_imageName :: Lens' UpdateImageVersion Text Source #

The name of the image.

updateImageVersionResponse_imageVersionArn :: Lens' UpdateImageVersionResponse (Maybe Text) Source #

The ARN of the image version.

updateImageVersionResponse_httpStatus :: Lens' UpdateImageVersionResponse Int Source #

The response's http status code.

UpdateInferenceExperiment

updateInferenceExperiment_dataStorageConfig :: Lens' UpdateInferenceExperiment (Maybe InferenceExperimentDataStorageConfig) Source #

The Amazon S3 location and configuration for storing inference request and response data.

updateInferenceExperiment_description :: Lens' UpdateInferenceExperiment (Maybe Text) Source #

The description of the inference experiment.

updateInferenceExperiment_modelVariants :: Lens' UpdateInferenceExperiment (Maybe (NonEmpty ModelVariantConfig)) Source #

An array of ModelVariantConfig objects. There is one for each variant, whose infrastructure configuration you want to update.

updateInferenceExperiment_schedule :: Lens' UpdateInferenceExperiment (Maybe InferenceExperimentSchedule) Source #

The duration for which the inference experiment will run. If the status of the inference experiment is Created, then you can update both the start and end dates. If the status of the inference experiment is Running, then you can update only the end date.

updateInferenceExperiment_shadowModeConfig :: Lens' UpdateInferenceExperiment (Maybe ShadowModeConfig) Source #

The configuration of ShadowMode inference experiment type. Use this field to specify a production variant which takes all the inference requests, and a shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant also specify the percentage of requests that Amazon SageMaker replicates.

updateInferenceExperiment_name :: Lens' UpdateInferenceExperiment Text Source #

The name of the inference experiment to be updated.

updateInferenceExperimentResponse_httpStatus :: Lens' UpdateInferenceExperimentResponse Int Source #

The response's http status code.

updateInferenceExperimentResponse_inferenceExperimentArn :: Lens' UpdateInferenceExperimentResponse Text Source #

The ARN of the updated inference experiment.

UpdateModelCard

updateModelCard_content :: Lens' UpdateModelCard (Maybe Text) Source #

The updated model card content. Content must be in model card JSON schema and provided as a string.

When updating model card content, be sure to include the full content and not just updated content.

updateModelCard_modelCardStatus :: Lens' UpdateModelCard (Maybe ModelCardStatus) Source #

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.

updateModelCard_modelCardName :: Lens' UpdateModelCard Text Source #

The name of the model card to update.

updateModelCardResponse_httpStatus :: Lens' UpdateModelCardResponse Int Source #

The response's http status code.

updateModelCardResponse_modelCardArn :: Lens' UpdateModelCardResponse Text Source #

The Amazon Resource Name (ARN) of the updated model card.

UpdateModelPackage

updateModelPackage_additionalInferenceSpecificationsToAdd :: Lens' UpdateModelPackage (Maybe (NonEmpty AdditionalInferenceSpecificationDefinition)) Source #

An array of additional Inference Specification objects to be added to the existing array additional Inference Specification. Total number of additional Inference Specifications can not exceed 15. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.

updateModelPackage_approvalDescription :: Lens' UpdateModelPackage (Maybe Text) Source #

A description for the approval status of the model.

updateModelPackage_customerMetadataProperties :: Lens' UpdateModelPackage (Maybe (HashMap Text Text)) Source #

The metadata properties associated with the model package versions.

updateModelPackage_customerMetadataPropertiesToRemove :: Lens' UpdateModelPackage (Maybe [Text]) Source #

The metadata properties associated with the model package versions to remove.

updateModelPackage_modelApprovalStatus :: Lens' UpdateModelPackage (Maybe ModelApprovalStatus) Source #

The approval status of the model.

updateModelPackage_modelPackageArn :: Lens' UpdateModelPackage Text Source #

The Amazon Resource Name (ARN) of the model package.

updateModelPackageResponse_httpStatus :: Lens' UpdateModelPackageResponse Int Source #

The response's http status code.

updateModelPackageResponse_modelPackageArn :: Lens' UpdateModelPackageResponse Text Source #

The Amazon Resource Name (ARN) of the model.

UpdateMonitoringAlert

updateMonitoringAlert_monitoringScheduleName :: Lens' UpdateMonitoringAlert Text Source #

The name of a monitoring schedule.

updateMonitoringAlert_monitoringAlertName :: Lens' UpdateMonitoringAlert Text Source #

The name of a monitoring alert.

updateMonitoringAlert_datapointsToAlert :: Lens' UpdateMonitoringAlert Natural Source #

Within EvaluationPeriod, how many execution failures will raise an alert.

updateMonitoringAlert_evaluationPeriod :: Lens' UpdateMonitoringAlert Natural Source #

The number of most recent monitoring executions to consider when evaluating alert status.

updateMonitoringAlertResponse_monitoringAlertName :: Lens' UpdateMonitoringAlertResponse (Maybe Text) Source #

The name of a monitoring alert.

updateMonitoringAlertResponse_httpStatus :: Lens' UpdateMonitoringAlertResponse Int Source #

The response's http status code.

updateMonitoringAlertResponse_monitoringScheduleArn :: Lens' UpdateMonitoringAlertResponse Text Source #

The Amazon Resource Name (ARN) of the monitoring schedule.

UpdateMonitoringSchedule

updateMonitoringSchedule_monitoringScheduleName :: Lens' UpdateMonitoringSchedule Text Source #

The name of the monitoring schedule. The name must be unique within an Amazon Web Services Region within an Amazon Web Services account.

updateMonitoringSchedule_monitoringScheduleConfig :: Lens' UpdateMonitoringSchedule MonitoringScheduleConfig Source #

The configuration object that specifies the monitoring schedule and defines the monitoring job.

updateMonitoringScheduleResponse_httpStatus :: Lens' UpdateMonitoringScheduleResponse Int Source #

The response's http status code.

updateMonitoringScheduleResponse_monitoringScheduleArn :: Lens' UpdateMonitoringScheduleResponse Text Source #

The Amazon Resource Name (ARN) of the monitoring schedule.

UpdateNotebookInstance

updateNotebookInstance_acceleratorTypes :: Lens' UpdateNotebookInstance (Maybe [NotebookInstanceAcceleratorType]) Source #

A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

updateNotebookInstance_additionalCodeRepositories :: Lens' UpdateNotebookInstance (Maybe [Text]) Source #

An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

updateNotebookInstance_defaultCodeRepository :: Lens' UpdateNotebookInstance (Maybe Text) Source #

The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

updateNotebookInstance_disassociateAcceleratorTypes :: Lens' UpdateNotebookInstance (Maybe Bool) Source #

A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

updateNotebookInstance_disassociateAdditionalCodeRepositories :: Lens' UpdateNotebookInstance (Maybe Bool) Source #

A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

updateNotebookInstance_disassociateDefaultCodeRepository :: Lens' UpdateNotebookInstance (Maybe Bool) Source #

The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

updateNotebookInstance_disassociateLifecycleConfig :: Lens' UpdateNotebookInstance (Maybe Bool) Source #

Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

updateNotebookInstance_instanceMetadataServiceConfiguration :: Lens' UpdateNotebookInstance (Maybe InstanceMetadataServiceConfiguration) Source #

Information on the IMDS configuration of the notebook instance

updateNotebookInstance_instanceType :: Lens' UpdateNotebookInstance (Maybe InstanceType) Source #

The Amazon ML compute instance type.

updateNotebookInstance_lifecycleConfigName :: Lens' UpdateNotebookInstance (Maybe Text) Source #

The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

updateNotebookInstance_roleArn :: Lens' UpdateNotebookInstance (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that SageMaker can assume to access the notebook instance. For more information, see SageMaker Roles.

To be able to pass this role to SageMaker, the caller of this API must have the iam:PassRole permission.

updateNotebookInstance_rootAccess :: Lens' UpdateNotebookInstance (Maybe RootAccess) Source #

Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

updateNotebookInstance_volumeSizeInGB :: Lens' UpdateNotebookInstance (Maybe Natural) Source #

The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

updateNotebookInstance_notebookInstanceName :: Lens' UpdateNotebookInstance Text Source #

The name of the notebook instance to update.

updateNotebookInstanceResponse_httpStatus :: Lens' UpdateNotebookInstanceResponse Int Source #

The response's http status code.

UpdateNotebookInstanceLifecycleConfig

updateNotebookInstanceLifecycleConfig_onCreate :: Lens' UpdateNotebookInstanceLifecycleConfig (Maybe [NotebookInstanceLifecycleHook]) Source #

The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

updateNotebookInstanceLifecycleConfig_onStart :: Lens' UpdateNotebookInstanceLifecycleConfig (Maybe [NotebookInstanceLifecycleHook]) Source #

The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

updateNotebookInstanceLifecycleConfig_notebookInstanceLifecycleConfigName :: Lens' UpdateNotebookInstanceLifecycleConfig Text Source #

The name of the lifecycle configuration.

updateNotebookInstanceLifecycleConfigResponse_httpStatus :: Lens' UpdateNotebookInstanceLifecycleConfigResponse Int Source #

The response's http status code.

UpdatePipeline

updatePipeline_parallelismConfiguration :: Lens' UpdatePipeline (Maybe ParallelismConfiguration) Source #

If specified, it applies to all executions of this pipeline by default.

updatePipeline_pipelineDefinition :: Lens' UpdatePipeline (Maybe Text) Source #

The JSON pipeline definition.

updatePipeline_pipelineDefinitionS3Location :: Lens' UpdatePipeline (Maybe PipelineDefinitionS3Location) Source #

The location of the pipeline definition stored in Amazon S3. If specified, SageMaker will retrieve the pipeline definition from this location.

updatePipeline_pipelineDescription :: Lens' UpdatePipeline (Maybe Text) Source #

The description of the pipeline.

updatePipeline_pipelineDisplayName :: Lens' UpdatePipeline (Maybe Text) Source #

The display name of the pipeline.

updatePipeline_roleArn :: Lens' UpdatePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) that the pipeline uses to execute.

updatePipeline_pipelineName :: Lens' UpdatePipeline Text Source #

The name of the pipeline to update.

updatePipelineResponse_pipelineArn :: Lens' UpdatePipelineResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated pipeline.

updatePipelineResponse_httpStatus :: Lens' UpdatePipelineResponse Int Source #

The response's http status code.

UpdatePipelineExecution

updatePipelineExecution_parallelismConfiguration :: Lens' UpdatePipelineExecution (Maybe ParallelismConfiguration) Source #

This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.

updatePipelineExecution_pipelineExecutionDescription :: Lens' UpdatePipelineExecution (Maybe Text) Source #

The description of the pipeline execution.

updatePipelineExecution_pipelineExecutionDisplayName :: Lens' UpdatePipelineExecution (Maybe Text) Source #

The display name of the pipeline execution.

updatePipelineExecution_pipelineExecutionArn :: Lens' UpdatePipelineExecution Text Source #

The Amazon Resource Name (ARN) of the pipeline execution.

updatePipelineExecutionResponse_pipelineExecutionArn :: Lens' UpdatePipelineExecutionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the updated pipeline execution.

updatePipelineExecutionResponse_httpStatus :: Lens' UpdatePipelineExecutionResponse Int Source #

The response's http status code.

UpdateProject

updateProject_projectDescription :: Lens' UpdateProject (Maybe Text) Source #

The description for the project.

updateProject_serviceCatalogProvisioningUpdateDetails :: Lens' UpdateProject (Maybe ServiceCatalogProvisioningUpdateDetails) Source #

The product ID and provisioning artifact ID to provision a service catalog. The provisioning artifact ID will default to the latest provisioning artifact ID of the product, if you don't provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service Catalog.

updateProject_tags :: Lens' UpdateProject (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. In addition, the project must have tag update constraints set in order to include this parameter in the request. For more information, see Amazon Web Services Service Catalog Tag Update Constraints.

updateProject_projectName :: Lens' UpdateProject Text Source #

The name of the project.

updateProjectResponse_httpStatus :: Lens' UpdateProjectResponse Int Source #

The response's http status code.

updateProjectResponse_projectArn :: Lens' UpdateProjectResponse Text Source #

The Amazon Resource Name (ARN) of the project.

UpdateSpace

updateSpace_spaceSettings :: Lens' UpdateSpace (Maybe SpaceSettings) Source #

A collection of space settings.

updateSpace_domainId :: Lens' UpdateSpace Text Source #

The ID of the associated Domain.

updateSpace_spaceName :: Lens' UpdateSpace Text Source #

The name of the space.

updateSpaceResponse_spaceArn :: Lens' UpdateSpaceResponse (Maybe Text) Source #

The space's Amazon Resource Name (ARN).

updateSpaceResponse_httpStatus :: Lens' UpdateSpaceResponse Int Source #

The response's http status code.

UpdateTrainingJob

updateTrainingJob_profilerConfig :: Lens' UpdateTrainingJob (Maybe ProfilerConfigForUpdate) Source #

Configuration information for Amazon SageMaker Debugger system monitoring, framework profiling, and storage paths.

updateTrainingJob_profilerRuleConfigurations :: Lens' UpdateTrainingJob (Maybe [ProfilerRuleConfiguration]) Source #

Configuration information for Amazon SageMaker Debugger rules for profiling system and framework metrics.

updateTrainingJob_resourceConfig :: Lens' UpdateTrainingJob (Maybe ResourceConfigForUpdate) Source #

The training job ResourceConfig to update warm pool retention length.

updateTrainingJob_trainingJobName :: Lens' UpdateTrainingJob Text Source #

The name of a training job to update the Debugger profiling configuration.

updateTrainingJobResponse_httpStatus :: Lens' UpdateTrainingJobResponse Int Source #

The response's http status code.

updateTrainingJobResponse_trainingJobArn :: Lens' UpdateTrainingJobResponse Text Source #

The Amazon Resource Name (ARN) of the training job.

UpdateTrial

updateTrial_displayName :: Lens' UpdateTrial (Maybe Text) Source #

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

updateTrial_trialName :: Lens' UpdateTrial Text Source #

The name of the trial to update.

updateTrialResponse_trialArn :: Lens' UpdateTrialResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

updateTrialResponse_httpStatus :: Lens' UpdateTrialResponse Int Source #

The response's http status code.

UpdateTrialComponent

updateTrialComponent_displayName :: Lens' UpdateTrialComponent (Maybe Text) Source #

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

updateTrialComponent_endTime :: Lens' UpdateTrialComponent (Maybe UTCTime) Source #

When the component ended.

updateTrialComponent_inputArtifacts :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

Replaces all of the component's input artifacts with the specified artifacts.

updateTrialComponent_inputArtifactsToRemove :: Lens' UpdateTrialComponent (Maybe [Text]) Source #

The input artifacts to remove from the component.

updateTrialComponent_outputArtifacts :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

Replaces all of the component's output artifacts with the specified artifacts.

updateTrialComponent_outputArtifactsToRemove :: Lens' UpdateTrialComponent (Maybe [Text]) Source #

The output artifacts to remove from the component.

updateTrialComponent_parameters :: Lens' UpdateTrialComponent (Maybe (HashMap Text TrialComponentParameterValue)) Source #

Replaces all of the component's hyperparameters with the specified hyperparameters.

updateTrialComponent_parametersToRemove :: Lens' UpdateTrialComponent (Maybe [Text]) Source #

The hyperparameters to remove from the component.

updateTrialComponent_startTime :: Lens' UpdateTrialComponent (Maybe UTCTime) Source #

When the component started.

updateTrialComponent_status :: Lens' UpdateTrialComponent (Maybe TrialComponentStatus) Source #

The new status of the component.

updateTrialComponent_trialComponentName :: Lens' UpdateTrialComponent Text Source #

The name of the component to update.

updateTrialComponentResponse_trialComponentArn :: Lens' UpdateTrialComponentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

updateTrialComponentResponse_httpStatus :: Lens' UpdateTrialComponentResponse Int Source #

The response's http status code.

UpdateUserProfile

updateUserProfile_userSettings :: Lens' UpdateUserProfile (Maybe UserSettings) Source #

A collection of settings.

updateUserProfile_domainId :: Lens' UpdateUserProfile Text Source #

The domain ID.

updateUserProfile_userProfileName :: Lens' UpdateUserProfile Text Source #

The user profile name.

updateUserProfileResponse_userProfileArn :: Lens' UpdateUserProfileResponse (Maybe Text) Source #

The user profile Amazon Resource Name (ARN).

updateUserProfileResponse_httpStatus :: Lens' UpdateUserProfileResponse Int Source #

The response's http status code.

UpdateWorkforce

updateWorkforce_oidcConfig :: Lens' UpdateWorkforce (Maybe OidcConfig) Source #

Use this parameter to update your OIDC Identity Provider (IdP) configuration for a workforce made using your own IdP.

updateWorkforce_sourceIpConfig :: Lens' UpdateWorkforce (Maybe SourceIpConfig) Source #

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

updateWorkforce_workforceVpcConfig :: Lens' UpdateWorkforce (Maybe WorkforceVpcConfigRequest) Source #

Use this parameter to update your VPC configuration for a workforce.

updateWorkforce_workforceName :: Lens' UpdateWorkforce Text Source #

The name of the private workforce that you want to update. You can find your workforce name by using the operation.

updateWorkforceResponse_httpStatus :: Lens' UpdateWorkforceResponse Int Source #

The response's http status code.

updateWorkforceResponse_workforce :: Lens' UpdateWorkforceResponse Workforce Source #

A single private workforce. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

UpdateWorkteam

updateWorkteam_description :: Lens' UpdateWorkteam (Maybe Text) Source #

An updated description for the work team.

updateWorkteam_memberDefinitions :: Lens' UpdateWorkteam (Maybe (NonEmpty MemberDefinition)) Source #

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. You should not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

updateWorkteam_notificationConfiguration :: Lens' UpdateWorkteam (Maybe NotificationConfiguration) Source #

Configures SNS topic notifications for available or expiring work items

updateWorkteam_workteamName :: Lens' UpdateWorkteam Text Source #

The name of the work team to update.

updateWorkteamResponse_httpStatus :: Lens' UpdateWorkteamResponse Int Source #

The response's http status code.

updateWorkteamResponse_workteam :: Lens' UpdateWorkteamResponse Workteam Source #

A Workteam object that describes the updated work team.

Types

ActionSource

actionSource_sourceId :: Lens' ActionSource (Maybe Text) Source #

The ID of the source.

actionSource_sourceType :: Lens' ActionSource (Maybe Text) Source #

The type of the source.

actionSource_sourceUri :: Lens' ActionSource Text Source #

The URI of the source.

ActionSummary

actionSummary_actionArn :: Lens' ActionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the action.

actionSummary_actionName :: Lens' ActionSummary (Maybe Text) Source #

The name of the action.

actionSummary_actionType :: Lens' ActionSummary (Maybe Text) Source #

The type of the action.

actionSummary_creationTime :: Lens' ActionSummary (Maybe UTCTime) Source #

When the action was created.

actionSummary_lastModifiedTime :: Lens' ActionSummary (Maybe UTCTime) Source #

When the action was last modified.

actionSummary_source :: Lens' ActionSummary (Maybe ActionSource) Source #

The source of the action.

actionSummary_status :: Lens' ActionSummary (Maybe ActionStatus) Source #

The status of the action.

AdditionalInferenceSpecificationDefinition

additionalInferenceSpecificationDefinition_description :: Lens' AdditionalInferenceSpecificationDefinition (Maybe Text) Source #

A description of the additional Inference specification

additionalInferenceSpecificationDefinition_supportedContentTypes :: Lens' AdditionalInferenceSpecificationDefinition (Maybe [Text]) Source #

The supported MIME types for the input data.

additionalInferenceSpecificationDefinition_supportedRealtimeInferenceInstanceTypes :: Lens' AdditionalInferenceSpecificationDefinition (Maybe [ProductionVariantInstanceType]) Source #

A list of the instance types that are used to generate inferences in real-time.

additionalInferenceSpecificationDefinition_supportedResponseMIMETypes :: Lens' AdditionalInferenceSpecificationDefinition (Maybe [Text]) Source #

The supported MIME types for the output data.

additionalInferenceSpecificationDefinition_supportedTransformInstanceTypes :: Lens' AdditionalInferenceSpecificationDefinition (Maybe (NonEmpty TransformInstanceType)) Source #

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

additionalInferenceSpecificationDefinition_name :: Lens' AdditionalInferenceSpecificationDefinition Text Source #

A unique name to identify the additional inference specification. The name must be unique within the list of your additional inference specifications for a particular model package.

additionalInferenceSpecificationDefinition_containers :: Lens' AdditionalInferenceSpecificationDefinition (NonEmpty ModelPackageContainerDefinition) Source #

The Amazon ECR registry path of the Docker image that contains the inference code.

AgentVersion

agentVersion_version :: Lens' AgentVersion Text Source #

Version of the agent.

agentVersion_agentCount :: Lens' AgentVersion Integer Source #

The number of Edge Manager agents.

Alarm

alarm_alarmName :: Lens' Alarm (Maybe Text) Source #

The name of a CloudWatch alarm in your account.

AlgorithmSpecification

algorithmSpecification_algorithmName :: Lens' AlgorithmSpecification (Maybe Text) Source #

The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on Amazon Web Services Marketplace.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

Note that the AlgorithmName parameter is mutually exclusive with the TrainingImage parameter. If you specify a value for the AlgorithmName parameter, you can't specify a value for TrainingImage, and vice versa.

If you specify values for both parameters, the training job might break; if you don't specify any value for both parameters, the training job might raise a null error.

algorithmSpecification_containerArguments :: Lens' AlgorithmSpecification (Maybe (NonEmpty Text)) Source #

The arguments for a container used to run a training job. See How Amazon SageMaker Runs Your Training Image for additional information.

algorithmSpecification_containerEntrypoint :: Lens' AlgorithmSpecification (Maybe (NonEmpty Text)) Source #

The entrypoint script for a Docker container used to run a training job. This script takes precedence over the default train processing instructions. See How Amazon SageMaker Runs Your Training Image for more information.

algorithmSpecification_enableSageMakerMetricsTimeSeries :: Lens' AlgorithmSpecification (Maybe Bool) Source #

To generate and save time-series metrics during training, set to true. The default is false and time-series metrics aren't generated except in the following cases:

  • You use one of the SageMaker built-in algorithms

  • You use one of the following Prebuilt SageMaker Docker Images:

    • Tensorflow (version >= 1.15)
    • MXNet (version >= 1.6)
    • PyTorch (version >= 1.3)
  • You specify at least one MetricDefinition

algorithmSpecification_metricDefinitions :: Lens' AlgorithmSpecification (Maybe [MetricDefinition]) Source #

A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. SageMaker publishes each metric to Amazon CloudWatch.

algorithmSpecification_trainingImage :: Lens' AlgorithmSpecification (Maybe Text) Source #

The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for SageMaker built-in algorithms, see Docker Registry Paths and Example Code in the Amazon SageMaker developer guide. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information about using your custom training container, see Using Your Own Algorithms with Amazon SageMaker.

You must specify either the algorithm name to the AlgorithmName parameter or the image URI of the algorithm container to the TrainingImage parameter.

For more information, see the note in the AlgorithmName parameter description.

algorithmSpecification_trainingInputMode :: Lens' AlgorithmSpecification TrainingInputMode Source #

Undocumented member.

AlgorithmStatusDetails

algorithmStatusDetails_imageScanStatuses :: Lens' AlgorithmStatusDetails (Maybe [AlgorithmStatusItem]) Source #

The status of the scan of the algorithm's Docker image container.

algorithmStatusDetails_validationStatuses :: Lens' AlgorithmStatusDetails (Maybe [AlgorithmStatusItem]) Source #

The status of algorithm validation.

AlgorithmStatusItem

algorithmStatusItem_failureReason :: Lens' AlgorithmStatusItem (Maybe Text) Source #

if the overall status is Failed, the reason for the failure.

algorithmStatusItem_name :: Lens' AlgorithmStatusItem Text Source #

The name of the algorithm for which the overall status is being reported.

algorithmStatusItem_status :: Lens' AlgorithmStatusItem DetailedAlgorithmStatus Source #

The current status.

AlgorithmSummary

algorithmSummary_algorithmDescription :: Lens' AlgorithmSummary (Maybe Text) Source #

A brief description of the algorithm.

algorithmSummary_algorithmName :: Lens' AlgorithmSummary Text Source #

The name of the algorithm that is described by the summary.

algorithmSummary_algorithmArn :: Lens' AlgorithmSummary Text Source #

The Amazon Resource Name (ARN) of the algorithm.

algorithmSummary_creationTime :: Lens' AlgorithmSummary UTCTime Source #

A timestamp that shows when the algorithm was created.

algorithmSummary_algorithmStatus :: Lens' AlgorithmSummary AlgorithmStatus Source #

The overall status of the algorithm.

AlgorithmValidationProfile

algorithmValidationProfile_transformJobDefinition :: Lens' AlgorithmValidationProfile (Maybe TransformJobDefinition) Source #

The TransformJobDefinition object that describes the transform job that SageMaker runs to validate your algorithm.

algorithmValidationProfile_profileName :: Lens' AlgorithmValidationProfile Text Source #

The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

algorithmValidationProfile_trainingJobDefinition :: Lens' AlgorithmValidationProfile TrainingJobDefinition Source #

The TrainingJobDefinition object that describes the training job that SageMaker runs to validate your algorithm.

AlgorithmValidationSpecification

algorithmValidationSpecification_validationRole :: Lens' AlgorithmValidationSpecification Text Source #

The IAM roles that SageMaker uses to run the training jobs.

algorithmValidationSpecification_validationProfiles :: Lens' AlgorithmValidationSpecification (NonEmpty AlgorithmValidationProfile) Source #

An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm.

AnnotationConsolidationConfig

annotationConsolidationConfig_annotationConsolidationLambdaArn :: Lens' AnnotationConsolidationConfig Text Source #

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoMultiClass
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoMultiClass
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoMultiClass
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoMultiClass
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoMultiClass
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoMultiClass
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoMultiClass
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoMultiClass
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoMultiClass
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoMultiClass
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoMultiClass
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VideoObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VideoObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VideoObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VideoObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VideoObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VideoObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VideoObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VideoObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VideoObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VideoObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VideoObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VideoObjectTracking

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic Segmentation Adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic Segmentation Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding Box Adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Bounding Box Verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentVideoObjectTracking

3D Point Cloud Object Detection Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D Point Cloud Object Tracking Adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation Adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

AppDetails

appDetails_appName :: Lens' AppDetails (Maybe Text) Source #

The name of the app.

appDetails_appType :: Lens' AppDetails (Maybe AppType) Source #

The type of app.

appDetails_creationTime :: Lens' AppDetails (Maybe UTCTime) Source #

The creation time.

appDetails_domainId :: Lens' AppDetails (Maybe Text) Source #

The domain ID.

appDetails_spaceName :: Lens' AppDetails (Maybe Text) Source #

The name of the space.

appDetails_status :: Lens' AppDetails (Maybe AppStatus) Source #

The status.

appDetails_userProfileName :: Lens' AppDetails (Maybe Text) Source #

The user profile name.

AppImageConfigDetails

appImageConfigDetails_appImageConfigArn :: Lens' AppImageConfigDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AppImageConfig.

appImageConfigDetails_appImageConfigName :: Lens' AppImageConfigDetails (Maybe Text) Source #

The name of the AppImageConfig. Must be unique to your account.

appImageConfigDetails_creationTime :: Lens' AppImageConfigDetails (Maybe UTCTime) Source #

When the AppImageConfig was created.

appImageConfigDetails_kernelGatewayImageConfig :: Lens' AppImageConfigDetails (Maybe KernelGatewayImageConfig) Source #

The configuration for the file system and kernels in the SageMaker image.

appImageConfigDetails_lastModifiedTime :: Lens' AppImageConfigDetails (Maybe UTCTime) Source #

When the AppImageConfig was last modified.

AppSpecification

appSpecification_containerArguments :: Lens' AppSpecification (Maybe (NonEmpty Text)) Source #

The arguments for a container used to run a processing job.

appSpecification_containerEntrypoint :: Lens' AppSpecification (Maybe (NonEmpty Text)) Source #

The entrypoint for a container used to run a processing job.

appSpecification_imageUri :: Lens' AppSpecification Text Source #

The container image to be run by the processing job.

ArtifactSource

artifactSource_sourceTypes :: Lens' ArtifactSource (Maybe [ArtifactSourceType]) Source #

A list of source types.

artifactSource_sourceUri :: Lens' ArtifactSource Text Source #

The URI of the source.

ArtifactSourceType

artifactSourceType_sourceIdType :: Lens' ArtifactSourceType ArtifactSourceIdType Source #

The type of ID.

artifactSourceType_value :: Lens' ArtifactSourceType Text Source #

The ID.

ArtifactSummary

artifactSummary_artifactArn :: Lens' ArtifactSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the artifact.

artifactSummary_artifactName :: Lens' ArtifactSummary (Maybe Text) Source #

The name of the artifact.

artifactSummary_artifactType :: Lens' ArtifactSummary (Maybe Text) Source #

The type of the artifact.

artifactSummary_creationTime :: Lens' ArtifactSummary (Maybe UTCTime) Source #

When the artifact was created.

artifactSummary_lastModifiedTime :: Lens' ArtifactSummary (Maybe UTCTime) Source #

When the artifact was last modified.

artifactSummary_source :: Lens' ArtifactSummary (Maybe ArtifactSource) Source #

The source of the artifact.

AssociationSummary

associationSummary_associationType :: Lens' AssociationSummary (Maybe AssociationEdgeType) Source #

The type of the association.

associationSummary_createdBy :: Lens' AssociationSummary (Maybe UserContext) Source #

Undocumented member.

associationSummary_creationTime :: Lens' AssociationSummary (Maybe UTCTime) Source #

When the association was created.

associationSummary_destinationArn :: Lens' AssociationSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the destination.

associationSummary_destinationName :: Lens' AssociationSummary (Maybe Text) Source #

The name of the destination.

associationSummary_destinationType :: Lens' AssociationSummary (Maybe Text) Source #

The destination type.

associationSummary_sourceArn :: Lens' AssociationSummary (Maybe Text) Source #

The ARN of the source.

associationSummary_sourceName :: Lens' AssociationSummary (Maybe Text) Source #

The name of the source.

associationSummary_sourceType :: Lens' AssociationSummary (Maybe Text) Source #

The source type.

AsyncInferenceClientConfig

asyncInferenceClientConfig_maxConcurrentInvocationsPerInstance :: Lens' AsyncInferenceClientConfig (Maybe Natural) Source #

The maximum number of concurrent requests sent by the SageMaker client to the model container. If no value is provided, SageMaker chooses an optimal value.

AsyncInferenceConfig

asyncInferenceConfig_clientConfig :: Lens' AsyncInferenceConfig (Maybe AsyncInferenceClientConfig) Source #

Configures the behavior of the client used by SageMaker to interact with the model container during asynchronous inference.

asyncInferenceConfig_outputConfig :: Lens' AsyncInferenceConfig AsyncInferenceOutputConfig Source #

Specifies the configuration for asynchronous inference invocation outputs.

AsyncInferenceNotificationConfig

asyncInferenceNotificationConfig_errorTopic :: Lens' AsyncInferenceNotificationConfig (Maybe Text) Source #

Amazon SNS topic to post a notification to when inference fails. If no topic is provided, no notification is sent on failure.

asyncInferenceNotificationConfig_successTopic :: Lens' AsyncInferenceNotificationConfig (Maybe Text) Source #

Amazon SNS topic to post a notification to when inference completes successfully. If no topic is provided, no notification is sent on success.

AsyncInferenceOutputConfig

asyncInferenceOutputConfig_kmsKeyId :: Lens' AsyncInferenceOutputConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the asynchronous inference output in Amazon S3.

asyncInferenceOutputConfig_notificationConfig :: Lens' AsyncInferenceOutputConfig (Maybe AsyncInferenceNotificationConfig) Source #

Specifies the configuration for notifications of inference results for asynchronous inference.

asyncInferenceOutputConfig_s3OutputPath :: Lens' AsyncInferenceOutputConfig Text Source #

The Amazon S3 location to upload inference responses to.

AthenaDatasetDefinition

athenaDatasetDefinition_kmsKeyId :: Lens' AthenaDatasetDefinition (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

athenaDatasetDefinition_outputCompression :: Lens' AthenaDatasetDefinition (Maybe AthenaResultCompressionType) Source #

Undocumented member.

athenaDatasetDefinition_workGroup :: Lens' AthenaDatasetDefinition (Maybe Text) Source #

Undocumented member.

athenaDatasetDefinition_catalog :: Lens' AthenaDatasetDefinition Text Source #

Undocumented member.

athenaDatasetDefinition_database :: Lens' AthenaDatasetDefinition Text Source #

Undocumented member.

athenaDatasetDefinition_queryString :: Lens' AthenaDatasetDefinition Text Source #

Undocumented member.

athenaDatasetDefinition_outputS3Uri :: Lens' AthenaDatasetDefinition Text Source #

The location in Amazon S3 where Athena query results are stored.

athenaDatasetDefinition_outputFormat :: Lens' AthenaDatasetDefinition AthenaResultFormat Source #

Undocumented member.

AutoMLCandidate

autoMLCandidate_candidateProperties :: Lens' AutoMLCandidate (Maybe CandidateProperties) Source #

The properties of an AutoML candidate job.

autoMLCandidate_endTime :: Lens' AutoMLCandidate (Maybe UTCTime) Source #

The end time.

autoMLCandidate_failureReason :: Lens' AutoMLCandidate (Maybe Text) Source #

The failure reason.

autoMLCandidate_finalAutoMLJobObjectiveMetric :: Lens' AutoMLCandidate (Maybe FinalAutoMLJobObjectiveMetric) Source #

Undocumented member.

autoMLCandidate_inferenceContainers :: Lens' AutoMLCandidate (Maybe [AutoMLContainerDefinition]) Source #

Information about the inference container definitions.

autoMLCandidate_candidateName :: Lens' AutoMLCandidate Text Source #

The name of the candidate.

autoMLCandidate_objectiveStatus :: Lens' AutoMLCandidate ObjectiveStatus Source #

The objective's status.

autoMLCandidate_candidateSteps :: Lens' AutoMLCandidate [AutoMLCandidateStep] Source #

Information about the candidate's steps.

autoMLCandidate_candidateStatus :: Lens' AutoMLCandidate CandidateStatus Source #

The candidate's status.

autoMLCandidate_creationTime :: Lens' AutoMLCandidate UTCTime Source #

The creation time.

autoMLCandidate_lastModifiedTime :: Lens' AutoMLCandidate UTCTime Source #

The last modified time.

AutoMLCandidateGenerationConfig

autoMLCandidateGenerationConfig_featureSpecificationS3Uri :: Lens' AutoMLCandidateGenerationConfig (Maybe Text) Source #

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ "FeatureAttributeNames":["col1", "col2", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ "FeatureDataTypes":{"col1":"numeric", "col2":"categorical" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot will only support the following data types: numeric, categorical, text and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in ["col1", "col2", ...] is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

AutoMLCandidateStep

autoMLCandidateStep_candidateStepType :: Lens' AutoMLCandidateStep CandidateStepType Source #

Whether the candidate is at the transform, training, or processing step.

autoMLCandidateStep_candidateStepArn :: Lens' AutoMLCandidateStep Text Source #

The ARN for the candidate's step.

autoMLCandidateStep_candidateStepName :: Lens' AutoMLCandidateStep Text Source #

The name for the candidate's step.

AutoMLChannel

autoMLChannel_channelType :: Lens' AutoMLChannel (Maybe AutoMLChannelType) Source #

The channel type (optional) is an enum string. The default value is training. Channels for training and validation must share the same ContentType and TargetAttributeName. For information on specifying training and validation channel types, see How to specify training and validation datasets .

autoMLChannel_compressionType :: Lens' AutoMLChannel (Maybe CompressionType) Source #

You can use Gzip or None. The default value is None.

autoMLChannel_contentType :: Lens' AutoMLChannel (Maybe Text) Source #

The content type of the data from the input source. You can use text/csv;header=present or x-application/vnd.amazon+parquet. The default value is text/csv;header=present.

autoMLChannel_dataSource :: Lens' AutoMLChannel AutoMLDataSource Source #

The data source for an AutoML channel.

autoMLChannel_targetAttributeName :: Lens' AutoMLChannel Text Source #

The name of the target variable in supervised learning, usually represented by 'y'.

AutoMLContainerDefinition

autoMLContainerDefinition_environment :: Lens' AutoMLContainerDefinition (Maybe (HashMap Text Text)) Source #

The environment variables to set in the container. For more information, see .

autoMLContainerDefinition_image :: Lens' AutoMLContainerDefinition Text Source #

The Amazon Elastic Container Registry (Amazon ECR) path of the container. For more information, see .

autoMLContainerDefinition_modelDataUrl :: Lens' AutoMLContainerDefinition Text Source #

The location of the model artifacts. For more information, see .

AutoMLDataSource

autoMLDataSource_s3DataSource :: Lens' AutoMLDataSource AutoMLS3DataSource Source #

The Amazon S3 location of the input data.

AutoMLDataSplitConfig

autoMLDataSplitConfig_validationFraction :: Lens' AutoMLDataSplitConfig (Maybe Double) Source #

The validation fraction (optional) is a float that specifies the portion of the training dataset to be used for validation. The default value is 0.2, and values must be greater than 0 and less than 1. We recommend setting this value to be less than 0.5.

AutoMLJobArtifacts

autoMLJobArtifacts_candidateDefinitionNotebookLocation :: Lens' AutoMLJobArtifacts (Maybe Text) Source #

The URL of the notebook location.

autoMLJobArtifacts_dataExplorationNotebookLocation :: Lens' AutoMLJobArtifacts (Maybe Text) Source #

The URL of the notebook location.

AutoMLJobCompletionCriteria

autoMLJobCompletionCriteria_maxAutoMLJobRuntimeInSeconds :: Lens' AutoMLJobCompletionCriteria (Maybe Natural) Source #

The maximum runtime, in seconds, an AutoML job has to complete.

If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, will not be completed.

autoMLJobCompletionCriteria_maxCandidates :: Lens' AutoMLJobCompletionCriteria (Maybe Natural) Source #

The maximum number of times a training job is allowed to run.

autoMLJobCompletionCriteria_maxRuntimePerTrainingJobInSeconds :: Lens' AutoMLJobCompletionCriteria (Maybe Natural) Source #

The maximum time, in seconds, that each training job executed inside hyperparameter tuning is allowed to run as part of a hyperparameter tuning job. For more information, see the used by the action.

AutoMLJobConfig

autoMLJobConfig_candidateGenerationConfig :: Lens' AutoMLJobConfig (Maybe AutoMLCandidateGenerationConfig) Source #

The configuration for generating a candidate for an AutoML job (optional).

autoMLJobConfig_completionCriteria :: Lens' AutoMLJobConfig (Maybe AutoMLJobCompletionCriteria) Source #

How long an AutoML job is allowed to run, or how many candidates a job is allowed to generate.

autoMLJobConfig_dataSplitConfig :: Lens' AutoMLJobConfig (Maybe AutoMLDataSplitConfig) Source #

The configuration for splitting the input training dataset.

Type: AutoMLDataSplitConfig

autoMLJobConfig_mode :: Lens' AutoMLJobConfig (Maybe AutoMLMode) Source #

The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO. In AUTO mode, Autopilot chooses ENSEMBLING for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING for larger ones.

The ENSEMBLING mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING mode.

The HYPERPARAMETER_TUNING (HPO) mode uses the best hyperparameters to train the best version of a model. HPO will automatically select an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING mode.

autoMLJobConfig_securityConfig :: Lens' AutoMLJobConfig (Maybe AutoMLSecurityConfig) Source #

The security configuration for traffic encryption or Amazon VPC settings.

AutoMLJobObjective

autoMLJobObjective_metricName :: Lens' AutoMLJobObjective AutoMLMetricEnum Source #

The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.

Here are the options:

Accuracy
The ratio of the number of correctly classified items to the total number of (correctly and incorrectly) classified items. It is used for both binary and multiclass classification. Accuracy measures how close the predicted class values are to the actual values. Values for accuracy metrics vary between zero (0) and one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect inaccuracy.
AUC
The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms that return probabilities, such as logistic regression. To map the probabilities into classifications, these are compared against a threshold value.

The relevant curve is the receiver operating characteristic curve (ROC curve). The ROC curve plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives, but more false negatives.

AUC is the area under this ROC curve. Therefore, AUC provides an aggregated measure of the model performance across all possible classification thresholds. AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a score of one half (0.5) indicates that the prediction is not better than a random classifier.

BalancedAccuracy
BalancedAccuracy is a metric that measures the ratio of accurate predictions to all predictions. This ratio is calculated after normalizing true positives (TP) and true negatives (TN) by the total number of positive (P) and negative (N) values. It is used in both binary and multiclass classification and is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1. BalancedAccuracy gives a better measure of accuracy when the number of positives or negatives differ greatly from each other in an imbalanced dataset. For example, when only 1% of email is spam.
F1
The F1 score is the harmonic mean of the precision and recall, defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class, and false when they do not.

Precision is the ratio of the true positive predictions to all positive predictions, and it includes the false positives in a dataset. Precision measures the quality of the prediction when it predicts the positive class.

Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances. Recall measures how completely a model predicts the actual class members in a dataset.

F1 scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.

F1macro
The F1macro score applies F1 scoring to multiclass classification problems. It does this by calculating the precision and recall, and then taking their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro averages the individual scores to obtain the F1macro score. F1macro scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
MAE
The mean absolute error (MAE) is a measure of how different the predicted and actual values are, when they're averaged over all values. MAE is commonly used in regression analysis to understand model prediction error. If there is linear regression, MAE represents the average distance from a predicted line to the actual value. MAE is defined as the sum of absolute errors divided by the number of observations. Values range from 0 to infinity, with smaller numbers indicating a better model fit to the data.
MSE
The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive. The better a model is at predicting the actual values, the smaller the MSE value is
Precision
Precision measures how well an algorithm predicts the true positives (TP) out of all of the positives that it identifies. It is defined as follows: Precision = TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary classification. Precision is an important metric when the cost of a false positive is high. For example, the cost of a false positive is very high if an airplane safety system is falsely deemed safe to fly. A false positive (FP) reflects a positive prediction that is actually negative in the data.
PrecisionMacro
The precision macro computes precision for multiclass classification problems. It does this by calculating precision for each class and averaging scores to obtain precision for several classes. PrecisionMacro scores range from zero (0) to one (1). Higher scores reflect the model's ability to predict true positives (TP) out of all of the positives that it identifies, averaged across multiple classes.
R2
R2, also known as the coefficient of determination, is used in regression to quantify how much a model can explain the variance of a dependent variable. Values range from one (1) to negative one (-1). Higher numbers indicate a higher fraction of explained variability. R2 values close to zero (0) indicate that very little of the dependent variable can be explained by the model. Negative values indicate a poor fit and that the model is outperformed by a constant function. For linear regression, this is a horizontal line.
Recall
Recall measures how well an algorithm correctly predicts all of the true positives (TP) in a dataset. A true positive is a positive prediction that is also an actual positive value in the data. Recall is defined as follows: Recall = TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better ability of the model to predict true positives (TP) in the data, and is used in binary classification.

Recall is important when testing for cancer because it's used to find all of the true positives. A false positive (FP) reflects a positive prediction that is actually negative in the data. It is often insufficient to measure only recall, because predicting every output as a true positive will yield a perfect recall score.

RecallMacro
The RecallMacro computes recall for multiclass classification problems by calculating recall for each class and averaging scores to obtain recall for several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the model's ability to predict true positives (TP) in a dataset. Whereas, a true positive reflects a positive prediction that is also an actual positive value in the data. It is often insufficient to measure only recall, because predicting every output as a true positive will yield a perfect recall score.
RMSE
Root mean squared error (RMSE) measures the square root of the squared difference between predicted and actual values, and it's averaged over all values. It is used in regression analysis to understand model prediction error. It's an important metric to indicate the presence of large model errors and outliers. Values range from zero (0) to infinity, with smaller numbers indicating a better model fit to the data. RMSE is dependent on scale, and should not be used to compare datasets of different sizes.

If you do not specify a metric explicitly, the default behavior is to automatically use:

  • MSE: for regression.
  • F1: for binary classification
  • Accuracy: for multiclass classification.

AutoMLJobStepMetadata

autoMLJobStepMetadata_arn :: Lens' AutoMLJobStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AutoML job.

AutoMLJobSummary

autoMLJobSummary_endTime :: Lens' AutoMLJobSummary (Maybe UTCTime) Source #

The end time of an AutoML job.

autoMLJobSummary_failureReason :: Lens' AutoMLJobSummary (Maybe Text) Source #

The failure reason of an AutoML job.

autoMLJobSummary_partialFailureReasons :: Lens' AutoMLJobSummary (Maybe (NonEmpty AutoMLPartialFailureReason)) Source #

The list of reasons for partial failures within an AutoML job.

autoMLJobSummary_autoMLJobName :: Lens' AutoMLJobSummary Text Source #

The name of the AutoML job you are requesting.

autoMLJobSummary_autoMLJobArn :: Lens' AutoMLJobSummary Text Source #

The ARN of the AutoML job.

autoMLJobSummary_autoMLJobStatus :: Lens' AutoMLJobSummary AutoMLJobStatus Source #

The status of the AutoML job.

autoMLJobSummary_autoMLJobSecondaryStatus :: Lens' AutoMLJobSummary AutoMLJobSecondaryStatus Source #

The secondary status of the AutoML job.

autoMLJobSummary_creationTime :: Lens' AutoMLJobSummary UTCTime Source #

When the AutoML job was created.

autoMLJobSummary_lastModifiedTime :: Lens' AutoMLJobSummary UTCTime Source #

When the AutoML job was last modified.

AutoMLOutputDataConfig

autoMLOutputDataConfig_kmsKeyId :: Lens' AutoMLOutputDataConfig (Maybe Text) Source #

The Key Management Service (KMS) encryption key ID.

autoMLOutputDataConfig_s3OutputPath :: Lens' AutoMLOutputDataConfig Text Source #

The Amazon S3 output path. Must be 128 characters or less.

AutoMLPartialFailureReason

autoMLPartialFailureReason_partialFailureMessage :: Lens' AutoMLPartialFailureReason (Maybe Text) Source #

The message containing the reason for a partial failure of an AutoML job.

AutoMLS3DataSource

autoMLS3DataSource_s3DataType :: Lens' AutoMLS3DataSource AutoMLS3DataType Source #

The data type.

A ManifestFile should have the format shown below:

[ {"prefix": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/DOC-EXAMPLE-PREFIX/"},
"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-1",
"DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-2",
... "DOC-EXAMPLE-RELATIVE-PATH/DOC-EXAMPLE-FOLDER/DATA-N" ]

An S3Prefix should have the following format:

s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE

autoMLS3DataSource_s3Uri :: Lens' AutoMLS3DataSource Text Source #

The URL to the Amazon S3 data source.

AutoMLSecurityConfig

autoMLSecurityConfig_enableInterContainerTrafficEncryption :: Lens' AutoMLSecurityConfig (Maybe Bool) Source #

Whether to use traffic encryption between the container layers.

autoMLSecurityConfig_volumeKmsKeyId :: Lens' AutoMLSecurityConfig (Maybe Text) Source #

The key used to encrypt stored data.

autoMLSecurityConfig_vpcConfig :: Lens' AutoMLSecurityConfig (Maybe VpcConfig) Source #

The VPC configuration.

AutoRollbackConfig

autoRollbackConfig_alarms :: Lens' AutoRollbackConfig (Maybe (NonEmpty Alarm)) Source #

List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.

BatchDataCaptureConfig

batchDataCaptureConfig_generateInferenceId :: Lens' BatchDataCaptureConfig (Maybe Bool) Source #

Flag that indicates whether to append inference id to the output.

batchDataCaptureConfig_kmsKeyId :: Lens' BatchDataCaptureConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the batch transform job.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

batchDataCaptureConfig_destinationS3Uri :: Lens' BatchDataCaptureConfig Text Source #

The Amazon S3 location being used to capture the data.

BatchDescribeModelPackageError

batchDescribeModelPackageError_errorCode :: Lens' BatchDescribeModelPackageError Text Source #

batchDescribeModelPackageError_errorResponse :: Lens' BatchDescribeModelPackageError Text Source #

BatchDescribeModelPackageSummary

batchDescribeModelPackageSummary_modelApprovalStatus :: Lens' BatchDescribeModelPackageSummary (Maybe ModelApprovalStatus) Source #

The approval status of the model.

batchDescribeModelPackageSummary_modelPackageDescription :: Lens' BatchDescribeModelPackageSummary (Maybe Text) Source #

The description of the model package.

batchDescribeModelPackageSummary_modelPackageVersion :: Lens' BatchDescribeModelPackageSummary (Maybe Natural) Source #

The version number of a versioned model.

batchDescribeModelPackageSummary_modelPackageGroupName :: Lens' BatchDescribeModelPackageSummary Text Source #

The group name for the model package

batchDescribeModelPackageSummary_modelPackageArn :: Lens' BatchDescribeModelPackageSummary Text Source #

The Amazon Resource Name (ARN) of the model package.

batchDescribeModelPackageSummary_creationTime :: Lens' BatchDescribeModelPackageSummary UTCTime Source #

The creation time of the mortgage package summary.

batchDescribeModelPackageSummary_inferenceSpecification :: Lens' BatchDescribeModelPackageSummary InferenceSpecification Source #

Undocumented member.

batchDescribeModelPackageSummary_modelPackageStatus :: Lens' BatchDescribeModelPackageSummary ModelPackageStatus Source #

The status of the mortgage package.

BatchTransformInput

batchTransformInput_endTimeOffset :: Lens' BatchTransformInput (Maybe Text) Source #

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

batchTransformInput_featuresAttribute :: Lens' BatchTransformInput (Maybe Text) Source #

The attributes of the input data that are the input features.

batchTransformInput_inferenceAttribute :: Lens' BatchTransformInput (Maybe Text) Source #

The attribute of the input data that represents the ground truth label.

batchTransformInput_probabilityAttribute :: Lens' BatchTransformInput (Maybe Text) Source #

In a classification problem, the attribute that represents the class probability.

batchTransformInput_probabilityThresholdAttribute :: Lens' BatchTransformInput (Maybe Double) Source #

The threshold for the class probability to be evaluated as a positive result.

batchTransformInput_s3DataDistributionType :: Lens' BatchTransformInput (Maybe ProcessingS3DataDistributionType) Source #

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

batchTransformInput_s3InputMode :: Lens' BatchTransformInput (Maybe ProcessingS3InputMode) Source #

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

batchTransformInput_startTimeOffset :: Lens' BatchTransformInput (Maybe Text) Source #

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

batchTransformInput_dataCapturedDestinationS3Uri :: Lens' BatchTransformInput Text Source #

The Amazon S3 location being used to capture the data.

batchTransformInput_datasetFormat :: Lens' BatchTransformInput MonitoringDatasetFormat Source #

The dataset format for your batch transform job.

batchTransformInput_localPath :: Lens' BatchTransformInput Text Source #

Path to the filesystem where the batch transform data is available to the container.

Bias

bias_postTrainingReport :: Lens' Bias (Maybe MetricsSource) Source #

The post-training bias report for a model.

bias_preTrainingReport :: Lens' Bias (Maybe MetricsSource) Source #

The pre-training bias report for a model.

bias_report :: Lens' Bias (Maybe MetricsSource) Source #

The bias report for a model

BlueGreenUpdatePolicy

blueGreenUpdatePolicy_maximumExecutionTimeoutInSeconds :: Lens' BlueGreenUpdatePolicy (Maybe Natural) Source #

Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.

blueGreenUpdatePolicy_terminationWaitInSeconds :: Lens' BlueGreenUpdatePolicy (Maybe Natural) Source #

Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.

blueGreenUpdatePolicy_trafficRoutingConfiguration :: Lens' BlueGreenUpdatePolicy TrafficRoutingConfig Source #

Defines the traffic routing strategy to shift traffic from the old fleet to the new fleet during an endpoint deployment.

CacheHitResult

cacheHitResult_sourcePipelineExecutionArn :: Lens' CacheHitResult (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

CallbackStepMetadata

callbackStepMetadata_callbackToken :: Lens' CallbackStepMetadata (Maybe Text) Source #

The pipeline generated token from the Amazon SQS queue.

callbackStepMetadata_outputParameters :: Lens' CallbackStepMetadata (Maybe [OutputParameter]) Source #

A list of the output parameters of the callback step.

callbackStepMetadata_sqsQueueUrl :: Lens' CallbackStepMetadata (Maybe Text) Source #

The URL of the Amazon Simple Queue Service (Amazon SQS) queue used by the callback step.

CandidateArtifactLocations

candidateArtifactLocations_modelInsights :: Lens' CandidateArtifactLocations (Maybe Text) Source #

The Amazon S3 prefix to the model insight artifacts generated for the AutoML candidate.

candidateArtifactLocations_explainability :: Lens' CandidateArtifactLocations Text Source #

The Amazon S3 prefix to the explainability artifacts generated for the AutoML candidate.

CandidateProperties

candidateProperties_candidateArtifactLocations :: Lens' CandidateProperties (Maybe CandidateArtifactLocations) Source #

The Amazon S3 prefix to the artifacts generated for an AutoML candidate.

candidateProperties_candidateMetrics :: Lens' CandidateProperties (Maybe [MetricDatum]) Source #

Information about the candidate metrics for an AutoML job.

CanvasAppSettings

canvasAppSettings_timeSeriesForecastingSettings :: Lens' CanvasAppSettings (Maybe TimeSeriesForecastingSettings) Source #

Time series forecast settings for the Canvas app.

CapacitySize

capacitySize_type :: Lens' CapacitySize CapacitySizeType Source #

Specifies the endpoint capacity type.

  • INSTANCE_COUNT: The endpoint activates based on the number of instances.
  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.

capacitySize_value :: Lens' CapacitySize Natural Source #

Defines the capacity size, either as a number of instances or a capacity percentage.

CaptureContentTypeHeader

captureContentTypeHeader_csvContentTypes :: Lens' CaptureContentTypeHeader (Maybe (NonEmpty Text)) Source #

The list of all content type headers that SageMaker will treat as CSV and capture accordingly.

captureContentTypeHeader_jsonContentTypes :: Lens' CaptureContentTypeHeader (Maybe (NonEmpty Text)) Source #

The list of all content type headers that SageMaker will treat as JSON and capture accordingly.

CaptureOption

captureOption_captureMode :: Lens' CaptureOption CaptureMode Source #

Specify the boundary of data to capture.

CategoricalParameter

categoricalParameter_name :: Lens' CategoricalParameter Text Source #

The Name of the environment variable.

categoricalParameter_value :: Lens' CategoricalParameter (NonEmpty Text) Source #

The list of values you can pass.

CategoricalParameterRange

categoricalParameterRange_name :: Lens' CategoricalParameterRange Text Source #

The name of the categorical hyperparameter to tune.

categoricalParameterRange_values :: Lens' CategoricalParameterRange (NonEmpty Text) Source #

A list of the categories for the hyperparameter.

CategoricalParameterRangeSpecification

categoricalParameterRangeSpecification_values :: Lens' CategoricalParameterRangeSpecification (NonEmpty Text) Source #

The allowed categories for the hyperparameter.

Channel

channel_compressionType :: Lens' Channel (Maybe CompressionType) Source #

If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

channel_contentType :: Lens' Channel (Maybe Text) Source #

The MIME type of the data.

channel_inputMode :: Lens' Channel (Maybe TrainingInputMode) Source #

(Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

To use a model for incremental training, choose File input model.

channel_recordWrapperType :: Lens' Channel (Maybe RecordWrapper) Source #

Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

In File mode, leave this field unset or set it to None.

channel_shuffleConfig :: Lens' Channel (Maybe ShuffleConfig) Source #

A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

channel_channelName :: Lens' Channel Text Source #

The name of the channel.

channel_dataSource :: Lens' Channel DataSource Source #

The location of the channel data.

ChannelSpecification

channelSpecification_description :: Lens' ChannelSpecification (Maybe Text) Source #

A brief description of the channel.

channelSpecification_isRequired :: Lens' ChannelSpecification (Maybe Bool) Source #

Indicates whether the channel is required by the algorithm.

channelSpecification_supportedCompressionTypes :: Lens' ChannelSpecification (Maybe [CompressionType]) Source #

The allowed compression types, if data compression is used.

channelSpecification_name :: Lens' ChannelSpecification Text Source #

The name of the channel.

channelSpecification_supportedContentTypes :: Lens' ChannelSpecification [Text] Source #

The supported MIME types for the data.

channelSpecification_supportedInputModes :: Lens' ChannelSpecification (NonEmpty TrainingInputMode) Source #

The allowed input mode, either FILE or PIPE.

In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

CheckpointConfig

checkpointConfig_localPath :: Lens' CheckpointConfig (Maybe Text) Source #

(Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

checkpointConfig_s3Uri :: Lens' CheckpointConfig Text Source #

Identifies the S3 path where you want SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

ClarifyCheckStepMetadata

clarifyCheckStepMetadata_baselineUsedForDriftCheckConstraints :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of baseline constraints file to be used for the drift check.

clarifyCheckStepMetadata_calculatedBaselineConstraints :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of the newly calculated baseline constraints file.

clarifyCheckStepMetadata_checkJobArn :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the check processing job that was run by this step's execution.

clarifyCheckStepMetadata_checkType :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The type of the Clarify Check step

clarifyCheckStepMetadata_modelPackageGroupName :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The model package group name.

clarifyCheckStepMetadata_registerNewBaseline :: Lens' ClarifyCheckStepMetadata (Maybe Bool) Source #

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

clarifyCheckStepMetadata_skipCheck :: Lens' ClarifyCheckStepMetadata (Maybe Bool) Source #

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.

clarifyCheckStepMetadata_violationReport :: Lens' ClarifyCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of the violation report if violations are detected.

ClarifyExplainerConfig

clarifyExplainerConfig_enableExplanations :: Lens' ClarifyExplainerConfig (Maybe Text) Source #

A JMESPath boolean expression used to filter which records to explain. Explanations are activated by default. See EnableExplanations for additional information.

clarifyExplainerConfig_inferenceConfig :: Lens' ClarifyExplainerConfig (Maybe ClarifyInferenceConfig) Source #

The inference configuration parameter for the model container.

clarifyExplainerConfig_shapConfig :: Lens' ClarifyExplainerConfig ClarifyShapConfig Source #

The configuration for SHAP analysis.

ClarifyInferenceConfig

clarifyInferenceConfig_contentTemplate :: Lens' ClarifyInferenceConfig (Maybe Text) Source #

A template string used to format a JSON record into an acceptable model container input. For example, a ContentTemplate string '{"myfeatures":$features}' will format a list of features [1,2,3] into the record string '{"myfeatures":[1,2,3]}'. Required only when the model container input is in JSON Lines format.

clarifyInferenceConfig_featureHeaders :: Lens' ClarifyInferenceConfig (Maybe (NonEmpty Text)) Source #

The names of the features. If provided, these are included in the endpoint response payload to help readability of the InvokeEndpoint output. See the Response section under Invoke the endpoint in the Developer Guide for more information.

clarifyInferenceConfig_featureTypes :: Lens' ClarifyInferenceConfig (Maybe (NonEmpty ClarifyFeatureType)) Source #

A list of data types of the features (optional). Applicable only to NLP explainability. If provided, FeatureTypes must have at least one 'text' string (for example, ['text']). If FeatureTypes is not provided, the explainer infers the feature types based on the baseline data. The feature types are included in the endpoint response payload. For additional information see the response section under Invoke the endpoint in the Developer Guide for more information.

clarifyInferenceConfig_featuresAttribute :: Lens' ClarifyInferenceConfig (Maybe Text) Source #

Provides the JMESPath expression to extract the features from a model container input in JSON Lines format. For example, if FeaturesAttribute is the JMESPath expression 'myfeatures', it extracts a list of features [1,2,3] from request data '{"myfeatures":[1,2,3]}'.

clarifyInferenceConfig_labelAttribute :: Lens' ClarifyInferenceConfig (Maybe Text) Source #

A JMESPath expression used to locate the list of label headers in the model container output.

Example: If the model container output of a batch request is '{"labels":["cat","dog","fish"],"probability":[0.6,0.3,0.1]}', then set LabelAttribute to 'labels' to extract the list of label headers ["cat","dog","fish"]

clarifyInferenceConfig_labelHeaders :: Lens' ClarifyInferenceConfig (Maybe (NonEmpty Text)) Source #

For multiclass classification problems, the label headers are the names of the classes. Otherwise, the label header is the name of the predicted label. These are used to help readability for the output of the InvokeEndpoint API. See the response section under Invoke the endpoint in the Developer Guide for more information. If there are no label headers in the model container output, provide them manually using this parameter.

clarifyInferenceConfig_labelIndex :: Lens' ClarifyInferenceConfig (Maybe Natural) Source #

A zero-based index used to extract a label header or list of label headers from model container output in CSV format.

Example for a multiclass model: If the model container output consists of label headers followed by probabilities: '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"', set LabelIndex to 0 to select the label headers ['cat','dog','fish'].

clarifyInferenceConfig_maxPayloadInMB :: Lens' ClarifyInferenceConfig (Maybe Natural) Source #

The maximum payload size (MB) allowed of a request from the explainer to the model container. Defaults to 6 MB.

clarifyInferenceConfig_maxRecordCount :: Lens' ClarifyInferenceConfig (Maybe Natural) Source #

The maximum number of records in a request that the model container can process when querying the model container for the predictions of a synthetic dataset. A record is a unit of input data that inference can be made on, for example, a single line in CSV data. If MaxRecordCount is 1, the model container expects one record per request. A value of 2 or greater means that the model expects batch requests, which can reduce overhead and speed up the inferencing process. If this parameter is not provided, the explainer will tune the record count per request according to the model container's capacity at runtime.

clarifyInferenceConfig_probabilityAttribute :: Lens' ClarifyInferenceConfig (Maybe Text) Source #

A JMESPath expression used to extract the probability (or score) from the model container output if the model container is in JSON Lines format.

Example: If the model container output of a single request is '{"predicted_label":1,"probability":0.6}', then set ProbabilityAttribute to 'probability'.

clarifyInferenceConfig_probabilityIndex :: Lens' ClarifyInferenceConfig (Maybe Natural) Source #

A zero-based index used to extract a probability value (score) or list from model container output in CSV format. If this value is not provided, the entire model container output will be treated as a probability value (score) or list.

Example for a single class model: If the model container output consists of a string-formatted prediction label followed by its probability: '1,0.6', set ProbabilityIndex to 1 to select the probability value 0.6.

Example for a multiclass model: If the model container output consists of a string-formatted prediction label followed by its probability: '"[\'cat\',\'dog\',\'fish\']","[0.1,0.6,0.3]"', set ProbabilityIndex to 1 to select the probability values [0.1,0.6,0.3].

ClarifyShapBaselineConfig

clarifyShapBaselineConfig_mimeType :: Lens' ClarifyShapBaselineConfig (Maybe Text) Source #

The MIME type of the baseline data. Choose from 'text/csv' or 'application/jsonlines'. Defaults to 'text/csv'.

clarifyShapBaselineConfig_shapBaseline :: Lens' ClarifyShapBaselineConfig (Maybe Text) Source #

The inline SHAP baseline data in string format. ShapBaseline can have one or multiple records to be used as the baseline dataset. The format of the SHAP baseline file should be the same format as the training dataset. For example, if the training dataset is in CSV format and each record contains four features, and all features are numerical, then the format of the baseline data should also share these characteristics. For natural language processing (NLP) of text columns, the baseline value should be the value used to replace the unit of text specified by the Granularity of the TextConfig parameter. The size limit for ShapBasline is 4 KB. Use the ShapBaselineUri parameter if you want to provide more than 4 KB of baseline data.

clarifyShapBaselineConfig_shapBaselineUri :: Lens' ClarifyShapBaselineConfig (Maybe Text) Source #

The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.

ClarifyShapConfig

clarifyShapConfig_numberOfSamples :: Lens' ClarifyShapConfig (Maybe Natural) Source #

The number of samples to be used for analysis by the Kernal SHAP algorithm.

The number of samples determines the size of the synthetic dataset, which has an impact on latency of explainability requests. For more information, see the Synthetic data of Configure and create an endpoint.

clarifyShapConfig_seed :: Lens' ClarifyShapConfig (Maybe Int) Source #

The starting value used to initialize the random number generator in the explainer. Provide a value for this parameter to obtain a deterministic SHAP result.

clarifyShapConfig_textConfig :: Lens' ClarifyShapConfig (Maybe ClarifyTextConfig) Source #

A parameter that indicates if text features are treated as text and explanations are provided for individual units of text. Required for natural language processing (NLP) explainability only.

clarifyShapConfig_useLogit :: Lens' ClarifyShapConfig (Maybe Bool) Source #

A Boolean toggle to indicate if you want to use the logit function (true) or log-odds units (false) for model predictions. Defaults to false.

clarifyShapConfig_shapBaselineConfig :: Lens' ClarifyShapConfig ClarifyShapBaselineConfig Source #

The configuration for the SHAP baseline of the Kernal SHAP algorithm.

ClarifyTextConfig

clarifyTextConfig_language :: Lens' ClarifyTextConfig ClarifyTextLanguage Source #

Specifies the language of the text features in ISO 639-1 or ISO 639-3 code of a supported language.

For a mix of multiple languages, use code 'xx'.

clarifyTextConfig_granularity :: Lens' ClarifyTextConfig ClarifyTextGranularity Source #

The unit of granularity for the analysis of text features. For example, if the unit is 'token', then each token (like a word in English) of the text is treated as a feature. SHAP values are computed for each unit/feature.

CodeRepository

codeRepository_repositoryUrl :: Lens' CodeRepository Text Source #

The URL of the Git repository.

CodeRepositorySummary

codeRepositorySummary_gitConfig :: Lens' CodeRepositorySummary (Maybe GitConfig) Source #

Configuration details for the Git repository, including the URL where it is located and the ARN of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the repository.

codeRepositorySummary_codeRepositoryName :: Lens' CodeRepositorySummary Text Source #

The name of the Git repository.

codeRepositorySummary_codeRepositoryArn :: Lens' CodeRepositorySummary Text Source #

The Amazon Resource Name (ARN) of the Git repository.

codeRepositorySummary_creationTime :: Lens' CodeRepositorySummary UTCTime Source #

The date and time that the Git repository was created.

codeRepositorySummary_lastModifiedTime :: Lens' CodeRepositorySummary UTCTime Source #

The date and time that the Git repository was last modified.

CognitoConfig

cognitoConfig_userPool :: Lens' CognitoConfig Text Source #

A user pool is a user directory in Amazon Cognito. With a user pool, your users can sign in to your web or mobile app through Amazon Cognito. Your users can also sign in through social identity providers like Google, Facebook, Amazon, or Apple, and through SAML identity providers.

cognitoConfig_clientId :: Lens' CognitoConfig Text Source #

The client ID for your Amazon Cognito user pool.

CognitoMemberDefinition

cognitoMemberDefinition_userPool :: Lens' CognitoMemberDefinition Text Source #

An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

cognitoMemberDefinition_userGroup :: Lens' CognitoMemberDefinition Text Source #

An identifier for a user group.

cognitoMemberDefinition_clientId :: Lens' CognitoMemberDefinition Text Source #

An identifier for an application client. You must create the app client ID using Amazon Cognito.

CollectionConfiguration

collectionConfiguration_collectionName :: Lens' CollectionConfiguration (Maybe Text) Source #

The name of the tensor collection. The name must be unique relative to other rule configuration names.

collectionConfiguration_collectionParameters :: Lens' CollectionConfiguration (Maybe (HashMap Text Text)) Source #

Parameter values for the tensor collection. The allowed parameters are "name", "include_regex", "reduction_config", "save_config", "tensor_names", and "save_histogram".

CompilationJobSummary

compilationJobSummary_compilationEndTime :: Lens' CompilationJobSummary (Maybe UTCTime) Source #

The time when the model compilation job completed.

compilationJobSummary_compilationStartTime :: Lens' CompilationJobSummary (Maybe UTCTime) Source #

The time when the model compilation job started.

compilationJobSummary_compilationTargetDevice :: Lens' CompilationJobSummary (Maybe TargetDevice) Source #

The type of device that the model will run on after the compilation job has completed.

compilationJobSummary_compilationTargetPlatformAccelerator :: Lens' CompilationJobSummary (Maybe TargetPlatformAccelerator) Source #

The type of accelerator that the model will run on after the compilation job has completed.

compilationJobSummary_compilationTargetPlatformArch :: Lens' CompilationJobSummary (Maybe TargetPlatformArch) Source #

The type of architecture that the model will run on after the compilation job has completed.

compilationJobSummary_compilationTargetPlatformOs :: Lens' CompilationJobSummary (Maybe TargetPlatformOs) Source #

The type of OS that the model will run on after the compilation job has completed.

compilationJobSummary_lastModifiedTime :: Lens' CompilationJobSummary (Maybe UTCTime) Source #

The time when the model compilation job was last modified.

compilationJobSummary_compilationJobName :: Lens' CompilationJobSummary Text Source #

The name of the model compilation job that you want a summary for.

compilationJobSummary_compilationJobArn :: Lens' CompilationJobSummary Text Source #

The Amazon Resource Name (ARN) of the model compilation job.

compilationJobSummary_creationTime :: Lens' CompilationJobSummary UTCTime Source #

The time when the model compilation job was created.

compilationJobSummary_compilationJobStatus :: Lens' CompilationJobSummary CompilationJobStatus Source #

The status of the model compilation job.

ConditionStepMetadata

conditionStepMetadata_outcome :: Lens' ConditionStepMetadata (Maybe ConditionOutcome) Source #

The outcome of the Condition step evaluation.

ContainerDefinition

containerDefinition_containerHostname :: Lens' ContainerDefinition (Maybe Text) Source #

This parameter is ignored for models that contain only a PrimaryContainer.

When a ContainerDefinition is part of an inference pipeline, the value of the parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

containerDefinition_environment :: Lens' ContainerDefinition (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

containerDefinition_image :: Lens' ContainerDefinition (Maybe Text) Source #

The path where inference code is stored. This can be either in Amazon EC2 Container Registry or in a Docker registry that is accessible from the same VPC that you configure for your endpoint. If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

containerDefinition_imageConfig :: Lens' ContainerDefinition (Maybe ImageConfig) Source #

Specifies whether the model container is in Amazon ECR or a private Docker registry accessible from your Amazon Virtual Private Cloud (VPC). For information about storing containers in a private Docker registry, see Use a Private Docker Registry for Real-Time Inference Containers

containerDefinition_inferenceSpecificationName :: Lens' ContainerDefinition (Maybe Text) Source #

The inference specification name in the model package version.

containerDefinition_mode :: Lens' ContainerDefinition (Maybe ContainerMode) Source #

Whether the container hosts a single model or multiple models.

containerDefinition_modelDataUrl :: Lens' ContainerDefinition (Maybe Text) Source #

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.

If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.

If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

containerDefinition_modelPackageName :: Lens' ContainerDefinition (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the model package to use to create the model.

containerDefinition_multiModelConfig :: Lens' ContainerDefinition (Maybe MultiModelConfig) Source #

Specifies additional configuration for multi-model endpoints.

ContextSource

contextSource_sourceId :: Lens' ContextSource (Maybe Text) Source #

The ID of the source.

contextSource_sourceType :: Lens' ContextSource (Maybe Text) Source #

The type of the source.

contextSource_sourceUri :: Lens' ContextSource Text Source #

The URI of the source.

ContextSummary

contextSummary_contextArn :: Lens' ContextSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the context.

contextSummary_contextName :: Lens' ContextSummary (Maybe Text) Source #

The name of the context.

contextSummary_contextType :: Lens' ContextSummary (Maybe Text) Source #

The type of the context.

contextSummary_creationTime :: Lens' ContextSummary (Maybe UTCTime) Source #

When the context was created.

contextSummary_lastModifiedTime :: Lens' ContextSummary (Maybe UTCTime) Source #

When the context was last modified.

contextSummary_source :: Lens' ContextSummary (Maybe ContextSource) Source #

The source of the context.

ContinuousParameterRange

continuousParameterRange_scalingType :: Lens' ContinuousParameterRange (Maybe HyperParameterScalingType) Source #

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto
SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

continuousParameterRange_name :: Lens' ContinuousParameterRange Text Source #

The name of the continuous hyperparameter to tune.

continuousParameterRange_minValue :: Lens' ContinuousParameterRange Text Source #

The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

continuousParameterRange_maxValue :: Lens' ContinuousParameterRange Text Source #

The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

ContinuousParameterRangeSpecification

continuousParameterRangeSpecification_minValue :: Lens' ContinuousParameterRangeSpecification Text Source #

The minimum floating-point value allowed.

continuousParameterRangeSpecification_maxValue :: Lens' ContinuousParameterRangeSpecification Text Source #

The maximum floating-point value allowed.

CustomImage

customImage_imageVersionNumber :: Lens' CustomImage (Maybe Natural) Source #

The version number of the CustomImage.

customImage_imageName :: Lens' CustomImage Text Source #

The name of the CustomImage. Must be unique to your account.

customImage_appImageConfigName :: Lens' CustomImage Text Source #

The name of the AppImageConfig.

DataCaptureConfig

dataCaptureConfig_captureContentTypeHeader :: Lens' DataCaptureConfig (Maybe CaptureContentTypeHeader) Source #

Configuration specifying how to treat different headers. If no headers are specified SageMaker will by default base64 encode when capturing the data.

dataCaptureConfig_enableCapture :: Lens' DataCaptureConfig (Maybe Bool) Source #

Whether data capture should be enabled or disabled (defaults to enabled).

dataCaptureConfig_kmsKeyId :: Lens' DataCaptureConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service key that SageMaker uses to encrypt the captured data at rest using Amazon S3 server-side encryption.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

dataCaptureConfig_initialSamplingPercentage :: Lens' DataCaptureConfig Natural Source #

The percentage of requests SageMaker will capture. A lower value is recommended for Endpoints with high traffic.

dataCaptureConfig_destinationS3Uri :: Lens' DataCaptureConfig Text Source #

The Amazon S3 location used to capture the data.

dataCaptureConfig_captureOptions :: Lens' DataCaptureConfig (NonEmpty CaptureOption) Source #

Specifies data Model Monitor will capture. You can configure whether to collect only input, only output, or both

DataCaptureConfigSummary

dataCaptureConfigSummary_enableCapture :: Lens' DataCaptureConfigSummary Bool Source #

Whether data capture is enabled or disabled.

dataCaptureConfigSummary_captureStatus :: Lens' DataCaptureConfigSummary CaptureStatus Source #

Whether data capture is currently functional.

dataCaptureConfigSummary_currentSamplingPercentage :: Lens' DataCaptureConfigSummary Natural Source #

The percentage of requests being captured by your Endpoint.

dataCaptureConfigSummary_destinationS3Uri :: Lens' DataCaptureConfigSummary Text Source #

The Amazon S3 location being used to capture the data.

dataCaptureConfigSummary_kmsKeyId :: Lens' DataCaptureConfigSummary Text Source #

The KMS key being used to encrypt the data in Amazon S3.

DataCatalogConfig

dataCatalogConfig_tableName :: Lens' DataCatalogConfig Text Source #

The name of the Glue table.

dataCatalogConfig_catalog :: Lens' DataCatalogConfig Text Source #

The name of the Glue table catalog.

dataCatalogConfig_database :: Lens' DataCatalogConfig Text Source #

The name of the Glue table database.

DataProcessing

dataProcessing_inputFilter :: Lens' DataProcessing (Maybe Text) Source #

A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

Examples: "$", "$[1:]", "$.features"

dataProcessing_joinSource :: Lens' DataProcessing (Maybe JoinSource) Source #

Specifies the source of the data to join with the transformed data. The valid values are None and Input. The default value is None, which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input. You can specify OutputFilter as an additional filter to select a portion of the joined dataset and store it in the output file.

For JSON or JSONLines objects, such as a JSON array, SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

For CSV data, SageMaker takes each row as a JSON array and joins the transformed data with the input by appending each transformed row to the end of the input. The joined data has the original input data followed by the transformed data and the output is a CSV file.

For information on how joining in applied, see Workflow for Associating Inferences with Input Records.

dataProcessing_outputFilter :: Lens' DataProcessing (Maybe Text) Source #

A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

Examples: "$", "$[0,5:]", "$['id','SageMakerOutput']"

DataQualityAppSpecification

dataQualityAppSpecification_containerArguments :: Lens' DataQualityAppSpecification (Maybe (NonEmpty Text)) Source #

The arguments to send to the container that the monitoring job runs.

dataQualityAppSpecification_containerEntrypoint :: Lens' DataQualityAppSpecification (Maybe (NonEmpty Text)) Source #

The entrypoint for a container used to run a monitoring job.

dataQualityAppSpecification_environment :: Lens' DataQualityAppSpecification (Maybe (HashMap Text Text)) Source #

Sets the environment variables in the container that the monitoring job runs.

dataQualityAppSpecification_postAnalyticsProcessorSourceUri :: Lens' DataQualityAppSpecification (Maybe Text) Source #

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

dataQualityAppSpecification_recordPreprocessorSourceUri :: Lens' DataQualityAppSpecification (Maybe Text) Source #

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

dataQualityAppSpecification_imageUri :: Lens' DataQualityAppSpecification Text Source #

The container image that the data quality monitoring job runs.

DataQualityBaselineConfig

dataQualityBaselineConfig_baseliningJobName :: Lens' DataQualityBaselineConfig (Maybe Text) Source #

The name of the job that performs baselining for the data quality monitoring job.

dataQualityBaselineConfig_constraintsResource :: Lens' DataQualityBaselineConfig (Maybe MonitoringConstraintsResource) Source #

Undocumented member.

dataQualityBaselineConfig_statisticsResource :: Lens' DataQualityBaselineConfig (Maybe MonitoringStatisticsResource) Source #

Undocumented member.

DataQualityJobInput

dataQualityJobInput_batchTransformInput :: Lens' DataQualityJobInput (Maybe BatchTransformInput) Source #

Input object for the batch transform job.

dataQualityJobInput_endpointInput :: Lens' DataQualityJobInput (Maybe EndpointInput) Source #

Undocumented member.

DataSource

dataSource_fileSystemDataSource :: Lens' DataSource (Maybe FileSystemDataSource) Source #

The file system that is associated with a channel.

dataSource_s3DataSource :: Lens' DataSource (Maybe S3DataSource) Source #

The S3 location of the data source that is associated with a channel.

DatasetDefinition

datasetDefinition_athenaDatasetDefinition :: Lens' DatasetDefinition (Maybe AthenaDatasetDefinition) Source #

Undocumented member.

datasetDefinition_dataDistributionType :: Lens' DatasetDefinition (Maybe DataDistributionType) Source #

Whether the generated dataset is FullyReplicated or ShardedByS3Key (default).

datasetDefinition_inputMode :: Lens' DatasetDefinition (Maybe InputMode) Source #

Whether to use File or Pipe input mode. In File (default) mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

datasetDefinition_localPath :: Lens' DatasetDefinition (Maybe Text) Source #

The local path where you want Amazon SageMaker to download the Dataset Definition inputs to run a processing job. LocalPath is an absolute path to the input data. This is a required parameter when AppManaged is False (default).

datasetDefinition_redshiftDatasetDefinition :: Lens' DatasetDefinition (Maybe RedshiftDatasetDefinition) Source #

Undocumented member.

DebugHookConfig

debugHookConfig_collectionConfigurations :: Lens' DebugHookConfig (Maybe [CollectionConfiguration]) Source #

Configuration information for Amazon SageMaker Debugger tensor collections. To learn more about how to configure the CollectionConfiguration parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

debugHookConfig_hookParameters :: Lens' DebugHookConfig (Maybe (HashMap Text Text)) Source #

Configuration information for the Amazon SageMaker Debugger hook parameters.

debugHookConfig_localPath :: Lens' DebugHookConfig (Maybe Text) Source #

Path to local storage location for metrics and tensors. Defaults to /opt/ml/output/tensors/.

debugHookConfig_s3OutputPath :: Lens' DebugHookConfig Text Source #

Path to Amazon S3 storage location for metrics and tensors.

DebugRuleConfiguration

debugRuleConfiguration_instanceType :: Lens' DebugRuleConfiguration (Maybe ProcessingInstanceType) Source #

The instance type to deploy a custom rule for debugging a training job.

debugRuleConfiguration_localPath :: Lens' DebugRuleConfiguration (Maybe Text) Source #

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

debugRuleConfiguration_ruleParameters :: Lens' DebugRuleConfiguration (Maybe (HashMap Text Text)) Source #

Runtime configuration for rule container.

debugRuleConfiguration_s3OutputPath :: Lens' DebugRuleConfiguration (Maybe Text) Source #

Path to Amazon S3 storage location for rules.

debugRuleConfiguration_volumeSizeInGB :: Lens' DebugRuleConfiguration (Maybe Natural) Source #

The size, in GB, of the ML storage volume attached to the processing instance.

debugRuleConfiguration_ruleConfigurationName :: Lens' DebugRuleConfiguration Text Source #

The name of the rule configuration. It must be unique relative to other rule configuration names.

debugRuleConfiguration_ruleEvaluatorImage :: Lens' DebugRuleConfiguration Text Source #

The Amazon Elastic Container (ECR) Image for the managed rule evaluation.

DebugRuleEvaluationStatus

debugRuleEvaluationStatus_lastModifiedTime :: Lens' DebugRuleEvaluationStatus (Maybe UTCTime) Source #

Timestamp when the rule evaluation status was last modified.

debugRuleEvaluationStatus_ruleConfigurationName :: Lens' DebugRuleEvaluationStatus (Maybe Text) Source #

The name of the rule configuration.

debugRuleEvaluationStatus_ruleEvaluationJobArn :: Lens' DebugRuleEvaluationStatus (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule evaluation job.

debugRuleEvaluationStatus_ruleEvaluationStatus :: Lens' DebugRuleEvaluationStatus (Maybe RuleEvaluationStatus) Source #

Status of the rule evaluation.

debugRuleEvaluationStatus_statusDetails :: Lens' DebugRuleEvaluationStatus (Maybe Text) Source #

Details from the rule evaluation.

DefaultSpaceSettings

defaultSpaceSettings_executionRole :: Lens' DefaultSpaceSettings (Maybe Text) Source #

The execution role for the space.

defaultSpaceSettings_jupyterServerAppSettings :: Lens' DefaultSpaceSettings (Maybe JupyterServerAppSettings) Source #

Undocumented member.

defaultSpaceSettings_kernelGatewayAppSettings :: Lens' DefaultSpaceSettings (Maybe KernelGatewayAppSettings) Source #

Undocumented member.

defaultSpaceSettings_securityGroups :: Lens' DefaultSpaceSettings (Maybe [Text]) Source #

The security groups for the Amazon Virtual Private Cloud that the space uses for communication.

DeployedImage

deployedImage_resolutionTime :: Lens' DeployedImage (Maybe UTCTime) Source #

The date and time when the image path for the model resolved to the ResolvedImage

deployedImage_resolvedImage :: Lens' DeployedImage (Maybe Text) Source #

The specific digest path of the image hosted in this ProductionVariant.

deployedImage_specifiedImage :: Lens' DeployedImage (Maybe Text) Source #

The image path you specified when you created the model.

DeploymentConfig

deploymentConfig_autoRollbackConfiguration :: Lens' DeploymentConfig (Maybe AutoRollbackConfig) Source #

Automatic rollback configuration for handling endpoint deployment failures and recovery.

deploymentConfig_blueGreenUpdatePolicy :: Lens' DeploymentConfig BlueGreenUpdatePolicy Source #

Update policy for a blue/green deployment. If this update policy is specified, SageMaker creates a new fleet during the deployment while maintaining the old fleet. SageMaker flips traffic to the new fleet according to the specified traffic routing configuration. Only one update policy should be used in the deployment configuration. If no update policy is specified, SageMaker uses a blue/green deployment strategy with all at once traffic shifting by default.

DeploymentStage

deploymentStage_deploymentConfig :: Lens' DeploymentStage (Maybe EdgeDeploymentConfig) Source #

Configuration of the deployment details.

deploymentStage_stageName :: Lens' DeploymentStage Text Source #

The name of the stage.

deploymentStage_deviceSelectionConfig :: Lens' DeploymentStage DeviceSelectionConfig Source #

Configuration of the devices in the stage.

DeploymentStageStatusSummary

deploymentStageStatusSummary_stageName :: Lens' DeploymentStageStatusSummary Text Source #

The name of the stage.

deploymentStageStatusSummary_deviceSelectionConfig :: Lens' DeploymentStageStatusSummary DeviceSelectionConfig Source #

Configuration of the devices in the stage.

deploymentStageStatusSummary_deploymentConfig :: Lens' DeploymentStageStatusSummary EdgeDeploymentConfig Source #

Configuration of the deployment details.

deploymentStageStatusSummary_deploymentStatus :: Lens' DeploymentStageStatusSummary EdgeDeploymentStatus Source #

General status of the current state.

DesiredWeightAndCapacity

desiredWeightAndCapacity_desiredInstanceCount :: Lens' DesiredWeightAndCapacity (Maybe Natural) Source #

The variant's capacity.

desiredWeightAndCapacity_desiredWeight :: Lens' DesiredWeightAndCapacity (Maybe Double) Source #

The variant's weight.

desiredWeightAndCapacity_variantName :: Lens' DesiredWeightAndCapacity Text Source #

The name of the variant to update.

Device

device_description :: Lens' Device (Maybe Text) Source #

Description of the device.

device_iotThingName :: Lens' Device (Maybe Text) Source #

Amazon Web Services Internet of Things (IoT) object name.

device_deviceName :: Lens' Device Text Source #

The name of the device.

DeviceDeploymentSummary

deviceDeploymentSummary_deployedStageName :: Lens' DeviceDeploymentSummary (Maybe Text) Source #

The name of the deployed stage.

deviceDeploymentSummary_deploymentStartTime :: Lens' DeviceDeploymentSummary (Maybe UTCTime) Source #

The time when the deployment on the device started.

deviceDeploymentSummary_description :: Lens' DeviceDeploymentSummary (Maybe Text) Source #

The description of the device.

deviceDeploymentSummary_deviceDeploymentStatus :: Lens' DeviceDeploymentSummary (Maybe DeviceDeploymentStatus) Source #

The deployment status of the device.

deviceDeploymentSummary_deviceDeploymentStatusMessage :: Lens' DeviceDeploymentSummary (Maybe Text) Source #

The detailed error message for the deployoment status result.

deviceDeploymentSummary_deviceFleetName :: Lens' DeviceDeploymentSummary (Maybe Text) Source #

The name of the fleet to which the device belongs to.

deviceDeploymentSummary_edgeDeploymentPlanArn :: Lens' DeviceDeploymentSummary Text Source #

The ARN of the edge deployment plan.

deviceDeploymentSummary_edgeDeploymentPlanName :: Lens' DeviceDeploymentSummary Text Source #

The name of the edge deployment plan.

deviceDeploymentSummary_stageName :: Lens' DeviceDeploymentSummary Text Source #

The name of the stage in the edge deployment plan.

deviceDeploymentSummary_deviceName :: Lens' DeviceDeploymentSummary Text Source #

The name of the device.

deviceDeploymentSummary_deviceArn :: Lens' DeviceDeploymentSummary Text Source #

The ARN of the device.

DeviceFleetSummary

deviceFleetSummary_creationTime :: Lens' DeviceFleetSummary (Maybe UTCTime) Source #

Timestamp of when the device fleet was created.

deviceFleetSummary_lastModifiedTime :: Lens' DeviceFleetSummary (Maybe UTCTime) Source #

Timestamp of when the device fleet was last updated.

deviceFleetSummary_deviceFleetArn :: Lens' DeviceFleetSummary Text Source #

Amazon Resource Name (ARN) of the device fleet.

deviceFleetSummary_deviceFleetName :: Lens' DeviceFleetSummary Text Source #

Name of the device fleet.

DeviceSelectionConfig

deviceSelectionConfig_deviceNameContains :: Lens' DeviceSelectionConfig (Maybe Text) Source #

A filter to select devices with names containing this name.

deviceSelectionConfig_deviceNames :: Lens' DeviceSelectionConfig (Maybe [Text]) Source #

List of devices chosen to deploy.

deviceSelectionConfig_percentage :: Lens' DeviceSelectionConfig (Maybe Int) Source #

Percentage of devices in the fleet to deploy to the current stage.

deviceSelectionConfig_deviceSubsetType :: Lens' DeviceSelectionConfig DeviceSubsetType Source #

Type of device subsets to deploy to the current stage.

DeviceStats

deviceStats_connectedDeviceCount :: Lens' DeviceStats Integer Source #

The number of devices connected with a heartbeat.

deviceStats_registeredDeviceCount :: Lens' DeviceStats Integer Source #

The number of registered devices.

DeviceSummary

deviceSummary_agentVersion :: Lens' DeviceSummary (Maybe Text) Source #

Edge Manager agent version.

deviceSummary_description :: Lens' DeviceSummary (Maybe Text) Source #

A description of the device.

deviceSummary_deviceFleetName :: Lens' DeviceSummary (Maybe Text) Source #

The name of the fleet the device belongs to.

deviceSummary_iotThingName :: Lens' DeviceSummary (Maybe Text) Source #

The Amazon Web Services Internet of Things (IoT) object thing name associated with the device..

deviceSummary_latestHeartbeat :: Lens' DeviceSummary (Maybe UTCTime) Source #

The last heartbeat received from the device.

deviceSummary_models :: Lens' DeviceSummary (Maybe [EdgeModelSummary]) Source #

Models on the device.

deviceSummary_registrationTime :: Lens' DeviceSummary (Maybe UTCTime) Source #

The timestamp of the last registration or de-reregistration.

deviceSummary_deviceName :: Lens' DeviceSummary Text Source #

The unique identifier of the device.

deviceSummary_deviceArn :: Lens' DeviceSummary Text Source #

Amazon Resource Name (ARN) of the device.

DomainDetails

domainDetails_creationTime :: Lens' DomainDetails (Maybe UTCTime) Source #

The creation time.

domainDetails_domainArn :: Lens' DomainDetails (Maybe Text) Source #

The domain's Amazon Resource Name (ARN).

domainDetails_domainId :: Lens' DomainDetails (Maybe Text) Source #

The domain ID.

domainDetails_domainName :: Lens' DomainDetails (Maybe Text) Source #

The domain name.

domainDetails_lastModifiedTime :: Lens' DomainDetails (Maybe UTCTime) Source #

The last modified time.

domainDetails_status :: Lens' DomainDetails (Maybe DomainStatus) Source #

The status.

domainDetails_url :: Lens' DomainDetails (Maybe Text) Source #

The domain's URL.

DomainSettings

domainSettings_executionRoleIdentityConfig :: Lens' DomainSettings (Maybe ExecutionRoleIdentityConfig) Source #

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key.

domainSettings_rStudioServerProDomainSettings :: Lens' DomainSettings (Maybe RStudioServerProDomainSettings) Source #

A collection of settings that configure the RStudioServerPro Domain-level app.

domainSettings_securityGroupIds :: Lens' DomainSettings (Maybe [Text]) Source #

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

DomainSettingsForUpdate

domainSettingsForUpdate_executionRoleIdentityConfig :: Lens' DomainSettingsForUpdate (Maybe ExecutionRoleIdentityConfig) Source #

The configuration for attaching a SageMaker user profile name to the execution role as a sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.

domainSettingsForUpdate_rStudioServerProDomainSettingsForUpdate :: Lens' DomainSettingsForUpdate (Maybe RStudioServerProDomainSettingsForUpdate) Source #

A collection of RStudioServerPro Domain-level app settings to update.

domainSettingsForUpdate_securityGroupIds :: Lens' DomainSettingsForUpdate (Maybe [Text]) Source #

The security groups for the Amazon Virtual Private Cloud that the Domain uses for communication between Domain-level apps and user apps.

DriftCheckBaselines

driftCheckBaselines_bias :: Lens' DriftCheckBaselines (Maybe DriftCheckBias) Source #

Represents the drift check bias baselines that can be used when the model monitor is set using the model package.

driftCheckBaselines_explainability :: Lens' DriftCheckBaselines (Maybe DriftCheckExplainability) Source #

Represents the drift check explainability baselines that can be used when the model monitor is set using the model package.

driftCheckBaselines_modelDataQuality :: Lens' DriftCheckBaselines (Maybe DriftCheckModelDataQuality) Source #

Represents the drift check model data quality baselines that can be used when the model monitor is set using the model package.

driftCheckBaselines_modelQuality :: Lens' DriftCheckBaselines (Maybe DriftCheckModelQuality) Source #

Represents the drift check model quality baselines that can be used when the model monitor is set using the model package.

DriftCheckBias

driftCheckBias_configFile :: Lens' DriftCheckBias (Maybe FileSource) Source #

The bias config file for a model.

driftCheckBias_postTrainingConstraints :: Lens' DriftCheckBias (Maybe MetricsSource) Source #

The post-training constraints.

driftCheckBias_preTrainingConstraints :: Lens' DriftCheckBias (Maybe MetricsSource) Source #

The pre-training constraints.

DriftCheckExplainability

driftCheckExplainability_configFile :: Lens' DriftCheckExplainability (Maybe FileSource) Source #

The explainability config file for the model.

driftCheckExplainability_constraints :: Lens' DriftCheckExplainability (Maybe MetricsSource) Source #

The drift check explainability constraints.

DriftCheckModelDataQuality

driftCheckModelDataQuality_constraints :: Lens' DriftCheckModelDataQuality (Maybe MetricsSource) Source #

The drift check model data quality constraints.

driftCheckModelDataQuality_statistics :: Lens' DriftCheckModelDataQuality (Maybe MetricsSource) Source #

The drift check model data quality statistics.

DriftCheckModelQuality

driftCheckModelQuality_constraints :: Lens' DriftCheckModelQuality (Maybe MetricsSource) Source #

The drift check model quality constraints.

driftCheckModelQuality_statistics :: Lens' DriftCheckModelQuality (Maybe MetricsSource) Source #

The drift check model quality statistics.

EMRStepMetadata

eMRStepMetadata_clusterId :: Lens' EMRStepMetadata (Maybe Text) Source #

The identifier of the EMR cluster.

eMRStepMetadata_logFilePath :: Lens' EMRStepMetadata (Maybe Text) Source #

The path to the log file where the cluster step's failure root cause is recorded.

eMRStepMetadata_stepId :: Lens' EMRStepMetadata (Maybe Text) Source #

The identifier of the EMR cluster step.

eMRStepMetadata_stepName :: Lens' EMRStepMetadata (Maybe Text) Source #

The name of the EMR cluster step.

Edge

edge_associationType :: Lens' Edge (Maybe AssociationEdgeType) Source #

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

edge_destinationArn :: Lens' Edge (Maybe Text) Source #

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

edge_sourceArn :: Lens' Edge (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

EdgeDeploymentConfig

edgeDeploymentConfig_failureHandlingPolicy :: Lens' EdgeDeploymentConfig FailureHandlingPolicy Source #

Toggle that determines whether to rollback to previous configuration if the current deployment fails. By default this is turned on. You may turn this off if you want to investigate the errors yourself.

EdgeDeploymentModelConfig

edgeDeploymentModelConfig_modelHandle :: Lens' EdgeDeploymentModelConfig Text Source #

The name the device application uses to reference this model.

edgeDeploymentModelConfig_edgePackagingJobName :: Lens' EdgeDeploymentModelConfig Text Source #

The edge packaging job associated with this deployment.

EdgeDeploymentPlanSummary

edgeDeploymentPlanSummary_creationTime :: Lens' EdgeDeploymentPlanSummary (Maybe UTCTime) Source #

The time when the edge deployment plan was created.

edgeDeploymentPlanSummary_lastModifiedTime :: Lens' EdgeDeploymentPlanSummary (Maybe UTCTime) Source #

The time when the edge deployment plan was last updated.

edgeDeploymentPlanSummary_edgeDeploymentPlanArn :: Lens' EdgeDeploymentPlanSummary Text Source #

The ARN of the edge deployment plan.

edgeDeploymentPlanSummary_edgeDeploymentPlanName :: Lens' EdgeDeploymentPlanSummary Text Source #

The name of the edge deployment plan.

edgeDeploymentPlanSummary_deviceFleetName :: Lens' EdgeDeploymentPlanSummary Text Source #

The name of the device fleet used for the deployment.

edgeDeploymentPlanSummary_edgeDeploymentSuccess :: Lens' EdgeDeploymentPlanSummary Int Source #

The number of edge devices with the successful deployment.

edgeDeploymentPlanSummary_edgeDeploymentPending :: Lens' EdgeDeploymentPlanSummary Int Source #

The number of edge devices yet to pick up the deployment, or in progress.

edgeDeploymentPlanSummary_edgeDeploymentFailed :: Lens' EdgeDeploymentPlanSummary Int Source #

The number of edge devices that failed the deployment.

EdgeDeploymentStatus

edgeDeploymentStatus_edgeDeploymentStageStartTime :: Lens' EdgeDeploymentStatus (Maybe UTCTime) Source #

The time when the deployment API started.

edgeDeploymentStatus_edgeDeploymentStatusMessage :: Lens' EdgeDeploymentStatus (Maybe Text) Source #

A detailed message about deployment status in current stage.

edgeDeploymentStatus_stageStatus :: Lens' EdgeDeploymentStatus StageStatus Source #

The general status of the current stage.

edgeDeploymentStatus_edgeDeploymentSuccessInStage :: Lens' EdgeDeploymentStatus Int Source #

The number of edge devices with the successful deployment in the current stage.

edgeDeploymentStatus_edgeDeploymentPendingInStage :: Lens' EdgeDeploymentStatus Int Source #

The number of edge devices yet to pick up the deployment in current stage, or in progress.

edgeDeploymentStatus_edgeDeploymentFailedInStage :: Lens' EdgeDeploymentStatus Int Source #

The number of edge devices that failed the deployment in current stage.

EdgeModel

edgeModel_latestInference :: Lens' EdgeModel (Maybe UTCTime) Source #

The timestamp of the last inference that was made.

edgeModel_latestSampleTime :: Lens' EdgeModel (Maybe UTCTime) Source #

The timestamp of the last data sample taken.

edgeModel_modelName :: Lens' EdgeModel Text Source #

The name of the model.

edgeModel_modelVersion :: Lens' EdgeModel Text Source #

The model version.

EdgeModelStat

edgeModelStat_modelName :: Lens' EdgeModelStat Text Source #

The name of the model.

edgeModelStat_modelVersion :: Lens' EdgeModelStat Text Source #

The model version.

edgeModelStat_offlineDeviceCount :: Lens' EdgeModelStat Integer Source #

The number of devices that have this model version and do not have a heart beat.

edgeModelStat_connectedDeviceCount :: Lens' EdgeModelStat Integer Source #

The number of devices that have this model version and have a heart beat.

edgeModelStat_activeDeviceCount :: Lens' EdgeModelStat Integer Source #

The number of devices that have this model version, a heart beat, and are currently running.

edgeModelStat_samplingDeviceCount :: Lens' EdgeModelStat Integer Source #

The number of devices with this model version and are producing sample data.

EdgeModelSummary

edgeModelSummary_modelName :: Lens' EdgeModelSummary Text Source #

The name of the model.

edgeModelSummary_modelVersion :: Lens' EdgeModelSummary Text Source #

The version model.

EdgeOutputConfig

edgeOutputConfig_kmsKeyId :: Lens' EdgeOutputConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

edgeOutputConfig_presetDeploymentConfig :: Lens' EdgeOutputConfig (Maybe Text) Source #

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.
  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

edgeOutputConfig_presetDeploymentType :: Lens' EdgeOutputConfig (Maybe EdgePresetDeploymentType) Source #

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

edgeOutputConfig_s3OutputLocation :: Lens' EdgeOutputConfig Text Source #

The Amazon Simple Storage (S3) bucker URI.

EdgePackagingJobSummary

edgePackagingJobSummary_compilationJobName :: Lens' EdgePackagingJobSummary (Maybe Text) Source #

The name of the SageMaker Neo compilation job.

edgePackagingJobSummary_creationTime :: Lens' EdgePackagingJobSummary (Maybe UTCTime) Source #

The timestamp of when the job was created.

edgePackagingJobSummary_lastModifiedTime :: Lens' EdgePackagingJobSummary (Maybe UTCTime) Source #

The timestamp of when the edge packaging job was last updated.

edgePackagingJobSummary_modelName :: Lens' EdgePackagingJobSummary (Maybe Text) Source #

The name of the model.

edgePackagingJobSummary_modelVersion :: Lens' EdgePackagingJobSummary (Maybe Text) Source #

The version of the model.

edgePackagingJobSummary_edgePackagingJobArn :: Lens' EdgePackagingJobSummary Text Source #

The Amazon Resource Name (ARN) of the edge packaging job.

edgePackagingJobSummary_edgePackagingJobName :: Lens' EdgePackagingJobSummary Text Source #

The name of the edge packaging job.

edgePackagingJobSummary_edgePackagingJobStatus :: Lens' EdgePackagingJobSummary EdgePackagingJobStatus Source #

The status of the edge packaging job.

EdgePresetDeploymentOutput

edgePresetDeploymentOutput_artifact :: Lens' EdgePresetDeploymentOutput (Maybe Text) Source #

The Amazon Resource Name (ARN) of the generated deployable resource.

edgePresetDeploymentOutput_status :: Lens' EdgePresetDeploymentOutput (Maybe EdgePresetDeploymentStatus) Source #

The status of the deployable resource.

edgePresetDeploymentOutput_statusMessage :: Lens' EdgePresetDeploymentOutput (Maybe Text) Source #

Returns a message describing the status of the deployed resource.

edgePresetDeploymentOutput_type :: Lens' EdgePresetDeploymentOutput EdgePresetDeploymentType Source #

The deployment type created by SageMaker Edge Manager. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

Endpoint

endpoint_dataCaptureConfig :: Lens' Endpoint (Maybe DataCaptureConfigSummary) Source #

Undocumented member.

endpoint_failureReason :: Lens' Endpoint (Maybe Text) Source #

If the endpoint failed, the reason it failed.

endpoint_monitoringSchedules :: Lens' Endpoint (Maybe [MonitoringSchedule]) Source #

A list of monitoring schedules for the endpoint. For information about model monitoring, see Amazon SageMaker Model Monitor.

endpoint_productionVariants :: Lens' Endpoint (Maybe (NonEmpty ProductionVariantSummary)) Source #

A list of the production variants hosted on the endpoint. Each production variant is a model.

endpoint_shadowProductionVariants :: Lens' Endpoint (Maybe (NonEmpty ProductionVariantSummary)) Source #

A list of the shadow variants hosted on the endpoint. Each shadow variant is a model in shadow mode with production traffic replicated from the proudction variant.

endpoint_tags :: Lens' Endpoint (Maybe [Tag]) Source #

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

endpoint_endpointName :: Lens' Endpoint Text Source #

The name of the endpoint.

endpoint_endpointArn :: Lens' Endpoint Text Source #

The Amazon Resource Name (ARN) of the endpoint.

endpoint_endpointConfigName :: Lens' Endpoint Text Source #

The endpoint configuration associated with the endpoint.

endpoint_endpointStatus :: Lens' Endpoint EndpointStatus Source #

The status of the endpoint.

endpoint_creationTime :: Lens' Endpoint UTCTime Source #

The time that the endpoint was created.

endpoint_lastModifiedTime :: Lens' Endpoint UTCTime Source #

The last time the endpoint was modified.

EndpointConfigSummary

endpointConfigSummary_endpointConfigName :: Lens' EndpointConfigSummary Text Source #

The name of the endpoint configuration.

endpointConfigSummary_endpointConfigArn :: Lens' EndpointConfigSummary Text Source #

The Amazon Resource Name (ARN) of the endpoint configuration.

endpointConfigSummary_creationTime :: Lens' EndpointConfigSummary UTCTime Source #

A timestamp that shows when the endpoint configuration was created.

EndpointInfo

endpointInfo_endpointName :: Lens' EndpointInfo Text Source #

The name of a customer's endpoint.

EndpointInput

endpointInput_endTimeOffset :: Lens' EndpointInput (Maybe Text) Source #

If specified, monitoring jobs substract this time from the end time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

endpointInput_featuresAttribute :: Lens' EndpointInput (Maybe Text) Source #

The attributes of the input data that are the input features.

endpointInput_inferenceAttribute :: Lens' EndpointInput (Maybe Text) Source #

The attribute of the input data that represents the ground truth label.

endpointInput_probabilityAttribute :: Lens' EndpointInput (Maybe Text) Source #

In a classification problem, the attribute that represents the class probability.

endpointInput_probabilityThresholdAttribute :: Lens' EndpointInput (Maybe Double) Source #

The threshold for the class probability to be evaluated as a positive result.

endpointInput_s3DataDistributionType :: Lens' EndpointInput (Maybe ProcessingS3DataDistributionType) Source #

Whether input data distributed in Amazon S3 is fully replicated or sharded by an S3 key. Defaults to FullyReplicated

endpointInput_s3InputMode :: Lens' EndpointInput (Maybe ProcessingS3InputMode) Source #

Whether the Pipe or File is used as the input mode for transferring data for the monitoring job. Pipe mode is recommended for large datasets. File mode is useful for small files that fit in memory. Defaults to File.

endpointInput_startTimeOffset :: Lens' EndpointInput (Maybe Text) Source #

If specified, monitoring jobs substract this time from the start time. For information about using offsets for scheduling monitoring jobs, see Schedule Model Quality Monitoring Jobs.

endpointInput_endpointName :: Lens' EndpointInput Text Source #

An endpoint in customer's account which has enabled DataCaptureConfig enabled.

endpointInput_localPath :: Lens' EndpointInput Text Source #

Path to the filesystem where the endpoint data is available to the container.

EndpointInputConfiguration

endpointInputConfiguration_environmentParameterRanges :: Lens' EndpointInputConfiguration (Maybe EnvironmentParameterRanges) Source #

The parameter you want to benchmark against.

endpointInputConfiguration_inferenceSpecificationName :: Lens' EndpointInputConfiguration (Maybe Text) Source #

The inference specification name in the model package version.

endpointInputConfiguration_instanceType :: Lens' EndpointInputConfiguration ProductionVariantInstanceType Source #

The instance types to use for the load test.

EndpointMetadata

endpointMetadata_endpointConfigName :: Lens' EndpointMetadata (Maybe Text) Source #

The name of the endpoint configuration.

endpointMetadata_endpointStatus :: Lens' EndpointMetadata (Maybe EndpointStatus) Source #

The status of the endpoint. For possible values of the status of an endpoint, see EndpointSummary$EndpointStatus.

endpointMetadata_failureReason :: Lens' EndpointMetadata (Maybe Text) Source #

If the status of the endpoint is Failed, or the status is InService but update operation fails, this provides the reason why it failed.

endpointMetadata_endpointName :: Lens' EndpointMetadata Text Source #

The name of the endpoint.

EndpointOutputConfiguration

endpointOutputConfiguration_endpointName :: Lens' EndpointOutputConfiguration Text Source #

The name of the endpoint made during a recommendation job.

endpointOutputConfiguration_variantName :: Lens' EndpointOutputConfiguration Text Source #

The name of the production variant (deployed model) made during a recommendation job.

endpointOutputConfiguration_instanceType :: Lens' EndpointOutputConfiguration ProductionVariantInstanceType Source #

The instance type recommended by Amazon SageMaker Inference Recommender.

endpointOutputConfiguration_initialInstanceCount :: Lens' EndpointOutputConfiguration Int Source #

The number of instances recommended to launch initially.

EndpointPerformance

endpointPerformance_metrics :: Lens' EndpointPerformance InferenceMetrics Source #

The metrics for an existing endpoint.

endpointPerformance_endpointInfo :: Lens' EndpointPerformance EndpointInfo Source #

Undocumented member.

EndpointSummary

endpointSummary_endpointName :: Lens' EndpointSummary Text Source #

The name of the endpoint.

endpointSummary_endpointArn :: Lens' EndpointSummary Text Source #

The Amazon Resource Name (ARN) of the endpoint.

endpointSummary_creationTime :: Lens' EndpointSummary UTCTime Source #

A timestamp that shows when the endpoint was created.

endpointSummary_lastModifiedTime :: Lens' EndpointSummary UTCTime Source #

A timestamp that shows when the endpoint was last modified.

endpointSummary_endpointStatus :: Lens' EndpointSummary EndpointStatus Source #

The status of the endpoint.

  • OutOfService: Endpoint is not available to take incoming requests.
  • Creating: CreateEndpoint is executing.
  • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.
  • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.
  • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.
  • InService: Endpoint is available to process incoming requests.
  • Deleting: DeleteEndpoint is executing.
  • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

EnvironmentParameter

environmentParameter_key :: Lens' EnvironmentParameter Text Source #

The environment key suggested by the Amazon SageMaker Inference Recommender.

environmentParameter_valueType :: Lens' EnvironmentParameter Text Source #

The value type suggested by the Amazon SageMaker Inference Recommender.

environmentParameter_value :: Lens' EnvironmentParameter Text Source #

The value suggested by the Amazon SageMaker Inference Recommender.

EnvironmentParameterRanges

environmentParameterRanges_categoricalParameterRanges :: Lens' EnvironmentParameterRanges (Maybe (NonEmpty CategoricalParameter)) Source #

Specified a list of parameters for each category.

Experiment

experiment_createdBy :: Lens' Experiment (Maybe UserContext) Source #

Who created the experiment.

experiment_creationTime :: Lens' Experiment (Maybe UTCTime) Source #

When the experiment was created.

experiment_description :: Lens' Experiment (Maybe Text) Source #

The description of the experiment.

experiment_displayName :: Lens' Experiment (Maybe Text) Source #

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

experiment_experimentArn :: Lens' Experiment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

experiment_experimentName :: Lens' Experiment (Maybe Text) Source #

The name of the experiment.

experiment_lastModifiedBy :: Lens' Experiment (Maybe UserContext) Source #

Undocumented member.

experiment_lastModifiedTime :: Lens' Experiment (Maybe UTCTime) Source #

When the experiment was last modified.

experiment_source :: Lens' Experiment (Maybe ExperimentSource) Source #

Undocumented member.

experiment_tags :: Lens' Experiment (Maybe [Tag]) Source #

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

ExperimentConfig

experimentConfig_experimentName :: Lens' ExperimentConfig (Maybe Text) Source #

The name of an existing experiment to associate with the trial component.

experimentConfig_runName :: Lens' ExperimentConfig (Maybe Text) Source #

The name of the experiment run to associate with the trial component.

experimentConfig_trialComponentDisplayName :: Lens' ExperimentConfig (Maybe Text) Source #

The display name for the trial component. If this key isn't specified, the display name is the trial component name.

experimentConfig_trialName :: Lens' ExperimentConfig (Maybe Text) Source #

The name of an existing trial to associate the trial component with. If not specified, a new trial is created.

ExperimentSource

experimentSource_sourceType :: Lens' ExperimentSource (Maybe Text) Source #

The source type.

experimentSource_sourceArn :: Lens' ExperimentSource Text Source #

The Amazon Resource Name (ARN) of the source.

ExperimentSummary

experimentSummary_creationTime :: Lens' ExperimentSummary (Maybe UTCTime) Source #

When the experiment was created.

experimentSummary_displayName :: Lens' ExperimentSummary (Maybe Text) Source #

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

experimentSummary_experimentArn :: Lens' ExperimentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the experiment.

experimentSummary_experimentName :: Lens' ExperimentSummary (Maybe Text) Source #

The name of the experiment.

experimentSummary_experimentSource :: Lens' ExperimentSummary (Maybe ExperimentSource) Source #

Undocumented member.

experimentSummary_lastModifiedTime :: Lens' ExperimentSummary (Maybe UTCTime) Source #

When the experiment was last modified.

Explainability

explainability_report :: Lens' Explainability (Maybe MetricsSource) Source #

The explainability report for a model.

ExplainerConfig

explainerConfig_clarifyExplainerConfig :: Lens' ExplainerConfig (Maybe ClarifyExplainerConfig) Source #

A member of ExplainerConfig that contains configuration parameters for the SageMaker Clarify explainer.

FailStepMetadata

failStepMetadata_errorMessage :: Lens' FailStepMetadata (Maybe Text) Source #

A message that you define and then is processed and rendered by the Fail step when the error occurs.

FeatureDefinition

featureDefinition_featureName :: Lens' FeatureDefinition (Maybe Text) Source #

The name of a feature. The type must be a string. FeatureName cannot be any of the following: is_deleted, write_time, api_invocation_time.

featureDefinition_featureType :: Lens' FeatureDefinition (Maybe FeatureType) Source #

The value type of a feature. Valid values are Integral, Fractional, or String.

FeatureGroup

featureGroup_creationTime :: Lens' FeatureGroup (Maybe UTCTime) Source #

The time a FeatureGroup was created.

featureGroup_description :: Lens' FeatureGroup (Maybe Text) Source #

A free form description of a FeatureGroup.

featureGroup_eventTimeFeatureName :: Lens' FeatureGroup (Maybe Text) Source #

The name of the feature that stores the EventTime of a Record in a FeatureGroup.

A EventTime is point in time when a new event occurs that corresponds to the creation or update of a Record in FeatureGroup. All Records in the FeatureGroup must have a corresponding EventTime.

featureGroup_failureReason :: Lens' FeatureGroup (Maybe Text) Source #

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

featureGroup_featureDefinitions :: Lens' FeatureGroup (Maybe (NonEmpty FeatureDefinition)) Source #

A list of Features. Each Feature must include a FeatureName and a FeatureType.

Valid FeatureTypes are Integral, Fractional and String.

FeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time.

You can create up to 2,500 FeatureDefinitions per FeatureGroup.

featureGroup_featureGroupArn :: Lens' FeatureGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of a FeatureGroup.

featureGroup_featureGroupName :: Lens' FeatureGroup (Maybe Text) Source #

The name of the FeatureGroup.

featureGroup_featureGroupStatus :: Lens' FeatureGroup (Maybe FeatureGroupStatus) Source #

A FeatureGroup status.

featureGroup_lastModifiedTime :: Lens' FeatureGroup (Maybe UTCTime) Source #

A timestamp indicating the last time you updated the feature group.

featureGroup_lastUpdateStatus :: Lens' FeatureGroup (Maybe LastUpdateStatus) Source #

A value that indicates whether the feature group was updated successfully.

featureGroup_offlineStoreConfig :: Lens' FeatureGroup (Maybe OfflineStoreConfig) Source #

Undocumented member.

featureGroup_offlineStoreStatus :: Lens' FeatureGroup (Maybe OfflineStoreStatus) Source #

Undocumented member.

featureGroup_onlineStoreConfig :: Lens' FeatureGroup (Maybe OnlineStoreConfig) Source #

Undocumented member.

featureGroup_recordIdentifierFeatureName :: Lens' FeatureGroup (Maybe Text) Source #

The name of the Feature whose value uniquely identifies a Record defined in the FeatureGroup FeatureDefinitions.

featureGroup_roleArn :: Lens' FeatureGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM execution role used to create the feature group.

featureGroup_tags :: Lens' FeatureGroup (Maybe [Tag]) Source #

Tags used to define a FeatureGroup.

FeatureGroupSummary

featureGroupSummary_featureGroupStatus :: Lens' FeatureGroupSummary (Maybe FeatureGroupStatus) Source #

The status of a FeatureGroup. The status can be any of the following: Creating, Created, CreateFail, Deleting or DetailFail.

featureGroupSummary_offlineStoreStatus :: Lens' FeatureGroupSummary (Maybe OfflineStoreStatus) Source #

Notifies you if replicating data into the OfflineStore has failed. Returns either: Active or Blocked.

featureGroupSummary_featureGroupName :: Lens' FeatureGroupSummary Text Source #

The name of FeatureGroup.

featureGroupSummary_featureGroupArn :: Lens' FeatureGroupSummary Text Source #

Unique identifier for the FeatureGroup.

featureGroupSummary_creationTime :: Lens' FeatureGroupSummary UTCTime Source #

A timestamp indicating the time of creation time of the FeatureGroup.

FeatureMetadata

featureMetadata_creationTime :: Lens' FeatureMetadata (Maybe UTCTime) Source #

A timestamp indicating when the feature was created.

featureMetadata_description :: Lens' FeatureMetadata (Maybe Text) Source #

An optional description that you specify to better describe the feature.

featureMetadata_featureGroupArn :: Lens' FeatureMetadata (Maybe Text) Source #

The Amazon Resource Number (ARN) of the feature group.

featureMetadata_featureGroupName :: Lens' FeatureMetadata (Maybe Text) Source #

The name of the feature group containing the feature.

featureMetadata_featureName :: Lens' FeatureMetadata (Maybe Text) Source #

The name of feature.

featureMetadata_featureType :: Lens' FeatureMetadata (Maybe FeatureType) Source #

The data type of the feature.

featureMetadata_lastModifiedTime :: Lens' FeatureMetadata (Maybe UTCTime) Source #

A timestamp indicating when the feature was last modified.

featureMetadata_parameters :: Lens' FeatureMetadata (Maybe [FeatureParameter]) Source #

Optional key-value pairs that you specify to better describe the feature.

FeatureParameter

featureParameter_key :: Lens' FeatureParameter (Maybe Text) Source #

A key that must contain a value to describe the feature.

featureParameter_value :: Lens' FeatureParameter (Maybe Text) Source #

The value that belongs to a key.

FileSource

fileSource_contentDigest :: Lens' FileSource (Maybe Text) Source #

The digest of the file source.

fileSource_contentType :: Lens' FileSource (Maybe Text) Source #

The type of content stored in the file source.

fileSource_s3Uri :: Lens' FileSource Text Source #

The Amazon S3 URI for the file source.

FileSystemConfig

fileSystemConfig_defaultGid :: Lens' FileSystemConfig (Maybe Natural) Source #

The default POSIX group ID (GID). If not specified, defaults to 100.

fileSystemConfig_defaultUid :: Lens' FileSystemConfig (Maybe Natural) Source #

The default POSIX user ID (UID). If not specified, defaults to 1000.

fileSystemConfig_mountPath :: Lens' FileSystemConfig (Maybe Text) Source #

The path within the image to mount the user's EFS home directory. The directory should be empty. If not specified, defaults to /home/sagemaker-user.

FileSystemDataSource

fileSystemDataSource_fileSystemId :: Lens' FileSystemDataSource Text Source #

The file system id.

fileSystemDataSource_fileSystemAccessMode :: Lens' FileSystemDataSource FileSystemAccessMode Source #

The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

fileSystemDataSource_fileSystemType :: Lens' FileSystemDataSource FileSystemType Source #

The file system type.

fileSystemDataSource_directoryPath :: Lens' FileSystemDataSource Text Source #

The full path to the directory to associate with the channel.

Filter

filter_operator :: Lens' Filter (Maybe Operator) Source #

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals
The value of Name equals Value.
NotEquals
The value of Name doesn't equal Value.
Exists
The Name property exists.
NotExists
The Name property does not exist.
GreaterThan
The value of Name is greater than Value. Not supported for text properties.
GreaterThanOrEqualTo
The value of Name is greater than or equal to Value. Not supported for text properties.
LessThan
The value of Name is less than Value. Not supported for text properties.
LessThanOrEqualTo
The value of Name is less than or equal to Value. Not supported for text properties.
In
The value of Name is one of the comma delimited strings in Value. Only supported for text properties.
Contains
The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName
  • Experiment.ExperimentName
  • Experiment.Tags
  • Trial.DisplayName
  • Trial.TrialName
  • Trial.Tags
  • TrialComponent.DisplayName
  • TrialComponent.TrialComponentName
  • TrialComponent.Tags
  • TrialComponent.InputArtifacts
  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: "'CONTAINS' operator usage limit of 1 exceeded."

filter_value :: Lens' Filter (Maybe Text) Source #

A value used with Name and Operator to determine which resources satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

filter_name :: Lens' Filter Text Source #

A resource property name. For example, TrainingJobName. For valid property names, see SearchRecord. You must specify a valid property for the resource.

FinalAutoMLJobObjectiveMetric

finalAutoMLJobObjectiveMetric_type :: Lens' FinalAutoMLJobObjectiveMetric (Maybe AutoMLJobObjectiveType) Source #

The type of metric with the best result.

finalAutoMLJobObjectiveMetric_metricName :: Lens' FinalAutoMLJobObjectiveMetric AutoMLMetricEnum Source #

The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.

finalAutoMLJobObjectiveMetric_value :: Lens' FinalAutoMLJobObjectiveMetric Double Source #

The value of the metric with the best result.

FinalHyperParameterTuningJobObjectiveMetric

finalHyperParameterTuningJobObjectiveMetric_type :: Lens' FinalHyperParameterTuningJobObjectiveMetric (Maybe HyperParameterTuningJobObjectiveType) Source #

Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

finalHyperParameterTuningJobObjectiveMetric_metricName :: Lens' FinalHyperParameterTuningJobObjectiveMetric Text Source #

The name of the objective metric.

finalHyperParameterTuningJobObjectiveMetric_value :: Lens' FinalHyperParameterTuningJobObjectiveMetric Double Source #

The value of the objective metric.

FlowDefinitionOutputConfig

flowDefinitionOutputConfig_kmsKeyId :: Lens' FlowDefinitionOutputConfig (Maybe Text) Source #

The Amazon Key Management Service (KMS) key ID for server-side encryption.

flowDefinitionOutputConfig_s3OutputPath :: Lens' FlowDefinitionOutputConfig Text Source #

The Amazon S3 path where the object containing human output will be made available.

To learn more about the format of Amazon A2I output data, see Amazon A2I Output Data.

FlowDefinitionSummary

flowDefinitionSummary_failureReason :: Lens' FlowDefinitionSummary (Maybe Text) Source #

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

flowDefinitionSummary_flowDefinitionName :: Lens' FlowDefinitionSummary Text Source #

The name of the flow definition.

flowDefinitionSummary_flowDefinitionArn :: Lens' FlowDefinitionSummary Text Source #

The Amazon Resource Name (ARN) of the flow definition.

flowDefinitionSummary_flowDefinitionStatus :: Lens' FlowDefinitionSummary FlowDefinitionStatus Source #

The status of the flow definition. Valid values:

flowDefinitionSummary_creationTime :: Lens' FlowDefinitionSummary UTCTime Source #

The timestamp when SageMaker created the flow definition.

GitConfig

gitConfig_branch :: Lens' GitConfig (Maybe Text) Source #

The default branch for the Git repository.

gitConfig_secretArn :: Lens' GitConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

gitConfig_repositoryUrl :: Lens' GitConfig Text Source #

The URL where the Git repository is located.

GitConfigForUpdate

gitConfigForUpdate_secretArn :: Lens' GitConfigForUpdate (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

{"username": UserName, "password": Password}

HubContentDependency

hubContentDependency_dependencyCopyPath :: Lens' HubContentDependency (Maybe Text) Source #

The hub content dependency copy path.

hubContentDependency_dependencyOriginPath :: Lens' HubContentDependency (Maybe Text) Source #

The hub content dependency origin path.

HubContentInfo

hubContentInfo_hubContentDescription :: Lens' HubContentInfo (Maybe Text) Source #

A description of the hub content.

hubContentInfo_hubContentDisplayName :: Lens' HubContentInfo (Maybe Text) Source #

The display name of the hub content.

hubContentInfo_hubContentSearchKeywords :: Lens' HubContentInfo (Maybe [Text]) Source #

The searchable keywords for the hub content.

hubContentInfo_hubContentName :: Lens' HubContentInfo Text Source #

The name of the hub content.

hubContentInfo_hubContentArn :: Lens' HubContentInfo Text Source #

The Amazon Resource Name (ARN) of the hub content.

hubContentInfo_hubContentVersion :: Lens' HubContentInfo Text Source #

The version of the hub content.

hubContentInfo_hubContentType :: Lens' HubContentInfo HubContentType Source #

The type of hub content.

hubContentInfo_documentSchemaVersion :: Lens' HubContentInfo Text Source #

The version of the hub content document schema.

hubContentInfo_hubContentStatus :: Lens' HubContentInfo HubContentStatus Source #

The status of the hub content.

hubContentInfo_creationTime :: Lens' HubContentInfo UTCTime Source #

The date and time that the hub content was created.

HubInfo

hubInfo_hubDescription :: Lens' HubInfo (Maybe Text) Source #

A description of the hub.

hubInfo_hubDisplayName :: Lens' HubInfo (Maybe Text) Source #

The display name of the hub.

hubInfo_hubSearchKeywords :: Lens' HubInfo (Maybe [Text]) Source #

The searchable keywords for the hub.

hubInfo_hubName :: Lens' HubInfo Text Source #

The name of the hub.

hubInfo_hubArn :: Lens' HubInfo Text Source #

The Amazon Resource Name (ARN) of the hub.

hubInfo_hubStatus :: Lens' HubInfo HubStatus Source #

The status of the hub.

hubInfo_creationTime :: Lens' HubInfo UTCTime Source #

The date and time that the hub was created.

hubInfo_lastModifiedTime :: Lens' HubInfo UTCTime Source #

The date and time that the hub was last modified.

HubS3StorageConfig

hubS3StorageConfig_s3OutputPath :: Lens' HubS3StorageConfig (Maybe Text) Source #

The Amazon S3 output path for the hub.

HumanLoopActivationConditionsConfig

humanLoopActivationConditionsConfig_humanLoopActivationConditions :: Lens' HumanLoopActivationConditionsConfig Text Source #

JSON expressing use-case specific conditions declaratively. If any condition is matched, atomic tasks are created against the configured work team. The set of conditions is different for Rekognition and Textract. For more information about how to structure the JSON, see JSON Schema for Human Loop Activation Conditions in Amazon Augmented AI in the Amazon SageMaker Developer Guide.

HumanLoopActivationConfig

humanLoopActivationConfig_humanLoopActivationConditionsConfig :: Lens' HumanLoopActivationConfig HumanLoopActivationConditionsConfig Source #

Container structure for defining under what conditions SageMaker creates a human loop.

HumanLoopConfig

humanLoopConfig_publicWorkforceTaskPrice :: Lens' HumanLoopConfig (Maybe PublicWorkforceTaskPrice) Source #

Undocumented member.

humanLoopConfig_taskAvailabilityLifetimeInSeconds :: Lens' HumanLoopConfig (Maybe Natural) Source #

The length of time that a task remains available for review by human workers.

humanLoopConfig_taskKeywords :: Lens' HumanLoopConfig (Maybe (NonEmpty Text)) Source #

Keywords used to describe the task so that workers can discover the task.

humanLoopConfig_taskTimeLimitInSeconds :: Lens' HumanLoopConfig (Maybe Natural) Source #

The amount of time that a worker has to complete a task. The default value is 3,600 seconds (1 hour).

humanLoopConfig_workteamArn :: Lens' HumanLoopConfig Text Source #

Amazon Resource Name (ARN) of a team of workers. To learn more about the types of workforces and work teams you can create and use with Amazon A2I, see Create and Manage Workforces.

humanLoopConfig_humanTaskUiArn :: Lens' HumanLoopConfig Text Source #

The Amazon Resource Name (ARN) of the human task user interface.

You can use standard HTML and Crowd HTML Elements to create a custom worker task template. You use this template to create a human task UI.

To learn how to create a custom HTML template, see Create Custom Worker Task Template.

To learn how to create a human task UI, which is a worker task template that can be used in a flow definition, see Create and Delete a Worker Task Templates.

humanLoopConfig_taskTitle :: Lens' HumanLoopConfig Text Source #

A title for the human worker task.

humanLoopConfig_taskDescription :: Lens' HumanLoopConfig Text Source #

A description for the human worker task.

humanLoopConfig_taskCount :: Lens' HumanLoopConfig Natural Source #

The number of distinct workers who will perform the same task on each object. For example, if TaskCount is set to 3 for an image classification labeling job, three workers will classify each input image. Increasing TaskCount can improve label accuracy.

HumanLoopRequestSource

humanLoopRequestSource_awsManagedHumanLoopRequestSource :: Lens' HumanLoopRequestSource AwsManagedHumanLoopRequestSource Source #

Specifies whether Amazon Rekognition or Amazon Textract are used as the integration source. The default field settings and JSON parsing rules are different based on the integration source. Valid values:

HumanTaskConfig

humanTaskConfig_maxConcurrentTaskCount :: Lens' HumanTaskConfig (Maybe Natural) Source #

Defines the maximum number of data objects that can be labeled by human workers at the same time. Also referred to as batch size. Each object may have more than one worker at one time. The default value is 1000 objects. To increase the maximum value to 5000 objects, contact Amazon Web Services Support.

humanTaskConfig_publicWorkforceTaskPrice :: Lens' HumanTaskConfig (Maybe PublicWorkforceTaskPrice) Source #

The price that you pay for each task performed by an Amazon Mechanical Turk worker.

humanTaskConfig_taskAvailabilityLifetimeInSeconds :: Lens' HumanTaskConfig (Maybe Natural) Source #

The length of time that a task remains available for labeling by human workers. The default and maximum values for this parameter depend on the type of workforce you use.

  • If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43,200 seconds). The default is 6 hours (21,600 seconds).
  • If you choose a private or vendor workforce, the default value is 30 days (2592,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

humanTaskConfig_taskKeywords :: Lens' HumanTaskConfig (Maybe (NonEmpty Text)) Source #

Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

humanTaskConfig_workteamArn :: Lens' HumanTaskConfig Text Source #

The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

humanTaskConfig_uiConfig :: Lens' HumanTaskConfig UiConfig Source #

Information about the user interface that workers use to complete the labeling task.

humanTaskConfig_preHumanTaskLambdaArn :: Lens' HumanTaskConfig Text Source #

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Video Classification - Use this task type when you need workers to classify videos using predefined labels that you specify. Workers are shown videos and are asked to choose one label for each video.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoMultiClass
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoMultiClass
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoMultiClass
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoMultiClass
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoMultiClass
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoMultiClass
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoMultiClass
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoMultiClass
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoMultiClass
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoMultiClass
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoMultiClass
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoMultiClass

Video Frame Object Detection - Use this task type to have workers identify and locate objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to identify and localize various objects in a series of video frames, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectDetection

Video Frame Object Tracking - Use this task type to have workers track the movement of objects in a sequence of video frames (images extracted from a video) using bounding boxes. For example, you can use this task to ask workers to track the movement of objects, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VideoObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VideoObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VideoObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VideoObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VideoObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VideoObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VideoObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VideoObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VideoObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VideoObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VideoObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VideoObjectTracking

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as "votes" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

Video Frame Object Detection Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to classify and localize objects in a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectDetection

Video Frame Object Tracking Adjustment - Use this task type when you want workers to adjust bounding boxes that workers have added to video frames to track object movement across a sequence of video frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentVideoObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentVideoObjectTracking

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation
  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

humanTaskConfig_taskTitle :: Lens' HumanTaskConfig Text Source #

A title for the task for your human workers.

humanTaskConfig_taskDescription :: Lens' HumanTaskConfig Text Source #

A description of the task for your human workers.

humanTaskConfig_numberOfHumanWorkersPerDataObject :: Lens' HumanTaskConfig Natural Source #

The number of human workers that will label an object.

humanTaskConfig_taskTimeLimitInSeconds :: Lens' HumanTaskConfig Natural Source #

The amount of time that a worker has to complete a task.

If you create a custom labeling job, the maximum value for this parameter is 8 hours (28,800 seconds).

If you create a labeling job using a built-in task type the maximum for this parameter depends on the task type you use:

  • For image and text labeling jobs, the maximum is 8 hours (28,800 seconds).
  • For 3D point cloud and video frame labeling jobs, the maximum is 30 days (2952,000 seconds) for non-AL mode. For most users, the maximum is also 30 days.

humanTaskConfig_annotationConsolidationConfig :: Lens' HumanTaskConfig AnnotationConsolidationConfig Source #

Configures how labels are consolidated across human workers.

HumanTaskUiSummary

humanTaskUiSummary_humanTaskUiName :: Lens' HumanTaskUiSummary Text Source #

The name of the human task user interface.

humanTaskUiSummary_humanTaskUiArn :: Lens' HumanTaskUiSummary Text Source #

The Amazon Resource Name (ARN) of the human task user interface.

humanTaskUiSummary_creationTime :: Lens' HumanTaskUiSummary UTCTime Source #

A timestamp when SageMaker created the human task user interface.

HyperParameterAlgorithmSpecification

hyperParameterAlgorithmSpecification_algorithmName :: Lens' HyperParameterAlgorithmSpecification (Maybe Text) Source #

The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

hyperParameterAlgorithmSpecification_metricDefinitions :: Lens' HyperParameterAlgorithmSpecification (Maybe [MetricDefinition]) Source #

An array of MetricDefinition objects that specify the metrics that the algorithm emits.

hyperParameterAlgorithmSpecification_trainingImage :: Lens' HyperParameterAlgorithmSpecification (Maybe Text) Source #

The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

hyperParameterAlgorithmSpecification_trainingInputMode :: Lens' HyperParameterAlgorithmSpecification TrainingInputMode Source #

Undocumented member.

HyperParameterSpecification

hyperParameterSpecification_defaultValue :: Lens' HyperParameterSpecification (Maybe Text) Source #

The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

hyperParameterSpecification_description :: Lens' HyperParameterSpecification (Maybe Text) Source #

A brief description of the hyperparameter.

hyperParameterSpecification_isRequired :: Lens' HyperParameterSpecification (Maybe Bool) Source #

Indicates whether this hyperparameter is required.

hyperParameterSpecification_isTunable :: Lens' HyperParameterSpecification (Maybe Bool) Source #

Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

hyperParameterSpecification_range :: Lens' HyperParameterSpecification (Maybe ParameterRange) Source #

The allowed range for this hyperparameter.

hyperParameterSpecification_name :: Lens' HyperParameterSpecification Text Source #

The name of this hyperparameter. The name must be unique.

hyperParameterSpecification_type :: Lens' HyperParameterSpecification ParameterType Source #

The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

HyperParameterTrainingJobDefinition

hyperParameterTrainingJobDefinition_checkpointConfig :: Lens' HyperParameterTrainingJobDefinition (Maybe CheckpointConfig) Source #

Undocumented member.

hyperParameterTrainingJobDefinition_definitionName :: Lens' HyperParameterTrainingJobDefinition (Maybe Text) Source #

The job definition name.

hyperParameterTrainingJobDefinition_enableInterContainerTrafficEncryption :: Lens' HyperParameterTrainingJobDefinition (Maybe Bool) Source #

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

hyperParameterTrainingJobDefinition_enableManagedSpotTraining :: Lens' HyperParameterTrainingJobDefinition (Maybe Bool) Source #

A Boolean indicating whether managed spot training is enabled (True) or not (False).

hyperParameterTrainingJobDefinition_enableNetworkIsolation :: Lens' HyperParameterTrainingJobDefinition (Maybe Bool) Source #

Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

hyperParameterTrainingJobDefinition_hyperParameterRanges :: Lens' HyperParameterTrainingJobDefinition (Maybe ParameterRanges) Source #

Undocumented member.

hyperParameterTrainingJobDefinition_hyperParameterTuningResourceConfig :: Lens' HyperParameterTrainingJobDefinition (Maybe HyperParameterTuningResourceConfig) Source #

The configuration for the hyperparameter tuning resources, including the compute instances and storage volumes, used for training jobs launched by the tuning job. By default, storage volumes hold model artifacts and incremental states. Choose File for TrainingInputMode in the AlgorithmSpecification parameter to additionally store training data in the storage volume (optional).

hyperParameterTrainingJobDefinition_inputDataConfig :: Lens' HyperParameterTrainingJobDefinition (Maybe (NonEmpty Channel)) Source #

An array of Channel objects that specify the input for the training jobs that the tuning job launches.

hyperParameterTrainingJobDefinition_resourceConfig :: Lens' HyperParameterTrainingJobDefinition (Maybe ResourceConfig) Source #

The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

If you want to use hyperparameter optimization with instance type flexibility, use HyperParameterTuningResourceConfig instead.

hyperParameterTrainingJobDefinition_retryStrategy :: Lens' HyperParameterTrainingJobDefinition (Maybe RetryStrategy) Source #

The number of times to retry the job when the job fails due to an InternalServerError.

hyperParameterTrainingJobDefinition_staticHyperParameters :: Lens' HyperParameterTrainingJobDefinition (Maybe (HashMap Text Text)) Source #

Specifies the values of hyperparameters that do not change for the tuning job.

hyperParameterTrainingJobDefinition_tuningObjective :: Lens' HyperParameterTrainingJobDefinition (Maybe HyperParameterTuningJobObjective) Source #

Undocumented member.

hyperParameterTrainingJobDefinition_vpcConfig :: Lens' HyperParameterTrainingJobDefinition (Maybe VpcConfig) Source #

The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

hyperParameterTrainingJobDefinition_algorithmSpecification :: Lens' HyperParameterTrainingJobDefinition HyperParameterAlgorithmSpecification Source #

The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

hyperParameterTrainingJobDefinition_roleArn :: Lens' HyperParameterTrainingJobDefinition Text Source #

The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

hyperParameterTrainingJobDefinition_outputDataConfig :: Lens' HyperParameterTrainingJobDefinition OutputDataConfig Source #

Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

hyperParameterTrainingJobDefinition_stoppingCondition :: Lens' HyperParameterTrainingJobDefinition StoppingCondition Source #

Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long a managed spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

HyperParameterTrainingJobSummary

hyperParameterTrainingJobSummary_failureReason :: Lens' HyperParameterTrainingJobSummary (Maybe Text) Source #

The reason that the training job failed.

hyperParameterTrainingJobSummary_finalHyperParameterTuningJobObjectiveMetric :: Lens' HyperParameterTrainingJobSummary (Maybe FinalHyperParameterTuningJobObjectiveMetric) Source #

The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

hyperParameterTrainingJobSummary_objectiveStatus :: Lens' HyperParameterTrainingJobSummary (Maybe ObjectiveStatus) Source #

The status of the objective metric for the training job:

  • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.
  • Pending: The training job is in progress and evaluation of its final objective metric is pending.
  • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

hyperParameterTrainingJobSummary_trainingEndTime :: Lens' HyperParameterTrainingJobSummary (Maybe UTCTime) Source #

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

hyperParameterTrainingJobSummary_trainingJobDefinitionName :: Lens' HyperParameterTrainingJobSummary (Maybe Text) Source #

The training job definition name.

hyperParameterTrainingJobSummary_trainingStartTime :: Lens' HyperParameterTrainingJobSummary (Maybe UTCTime) Source #

The date and time that the training job started.

hyperParameterTrainingJobSummary_tuningJobName :: Lens' HyperParameterTrainingJobSummary (Maybe Text) Source #

The HyperParameter tuning job that launched the training job.

hyperParameterTrainingJobSummary_trainingJobName :: Lens' HyperParameterTrainingJobSummary Text Source #

The name of the training job.

hyperParameterTrainingJobSummary_trainingJobArn :: Lens' HyperParameterTrainingJobSummary Text Source #

The Amazon Resource Name (ARN) of the training job.

hyperParameterTrainingJobSummary_creationTime :: Lens' HyperParameterTrainingJobSummary UTCTime Source #

The date and time that the training job was created.

hyperParameterTrainingJobSummary_trainingJobStatus :: Lens' HyperParameterTrainingJobSummary TrainingJobStatus Source #

The status of the training job.

hyperParameterTrainingJobSummary_tunedHyperParameters :: Lens' HyperParameterTrainingJobSummary (HashMap Text Text) Source #

A list of the hyperparameters for which you specified ranges to search.

HyperParameterTuningInstanceConfig

hyperParameterTuningInstanceConfig_instanceType :: Lens' HyperParameterTuningInstanceConfig TrainingInstanceType Source #

The instance type used for processing of hyperparameter optimization jobs. Choose from general purpose (no GPUs) instance types: ml.m5.xlarge, ml.m5.2xlarge, and ml.m5.4xlarge or compute optimized (no GPUs) instance types: ml.c5.xlarge and ml.c5.2xlarge. For more information about instance types, see instance type descriptions.

hyperParameterTuningInstanceConfig_instanceCount :: Lens' HyperParameterTuningInstanceConfig Natural Source #

The number of instances of the type specified by InstanceType. Choose an instance count larger than 1 for distributed training algorithms. See SageMaker distributed training jobs for more informcration.

hyperParameterTuningInstanceConfig_volumeSizeInGB :: Lens' HyperParameterTuningInstanceConfig Natural Source #

The volume size in GB of the data to be processed for hyperparameter optimization (optional).

HyperParameterTuningJobConfig

hyperParameterTuningJobConfig_hyperParameterTuningJobObjective :: Lens' HyperParameterTuningJobConfig (Maybe HyperParameterTuningJobObjective) Source #

The HyperParameterTuningJobObjective specifies the objective metric used to evaluate the performance of training jobs launched by this tuning job.

hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges) Source #

The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches over to find the optimal configuration for the highest model performance against your chosen objective metric.

hyperParameterTuningJobConfig_randomSeed :: Lens' HyperParameterTuningJobConfig (Maybe Natural) Source #

A value used to initialize a pseudo-random number generator. Setting a random seed and using the same seed later for the same tuning job will allow hyperparameter optimization to find more a consistent hyperparameter configuration between the two runs.

hyperParameterTuningJobConfig_strategyConfig :: Lens' HyperParameterTuningJobConfig (Maybe HyperParameterTuningJobStrategyConfig) Source #

The configuration for the Hyperband optimization strategy. This parameter should be provided only if Hyperband is selected as the strategy for HyperParameterTuningJobConfig.

hyperParameterTuningJobConfig_trainingJobEarlyStoppingType :: Lens' HyperParameterTuningJobConfig (Maybe TrainingJobEarlyStoppingType) Source #

Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. Because the Hyperband strategy has its own advanced internal early stopping mechanism, TrainingJobEarlyStoppingType must be OFF to use Hyperband. This parameter can take on one of the following values (the default value is OFF):

OFF
Training jobs launched by the hyperparameter tuning job do not use early stopping.
AUTO
SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

hyperParameterTuningJobConfig_tuningJobCompletionCriteria :: Lens' HyperParameterTuningJobConfig (Maybe TuningJobCompletionCriteria) Source #

The tuning job's completion criteria.

hyperParameterTuningJobConfig_strategy :: Lens' HyperParameterTuningJobConfig HyperParameterTuningJobStrategyType Source #

Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. For information about search strategies, see How Hyperparameter Tuning Works.

hyperParameterTuningJobConfig_resourceLimits :: Lens' HyperParameterTuningJobConfig ResourceLimits Source #

The ResourceLimits object that specifies the maximum number of training and parallel training jobs that can be used for this hyperparameter tuning job.

HyperParameterTuningJobObjective

hyperParameterTuningJobObjective_type :: Lens' HyperParameterTuningJobObjective HyperParameterTuningJobObjectiveType Source #

Whether to minimize or maximize the objective metric.

hyperParameterTuningJobObjective_metricName :: Lens' HyperParameterTuningJobObjective Text Source #

The name of the metric to use for the objective metric.

HyperParameterTuningJobSearchEntity

hyperParameterTuningJobSearchEntity_bestTrainingJob :: Lens' HyperParameterTuningJobSearchEntity (Maybe HyperParameterTrainingJobSummary) Source #

Undocumented member.

hyperParameterTuningJobSearchEntity_creationTime :: Lens' HyperParameterTuningJobSearchEntity (Maybe UTCTime) Source #

The time that a hyperparameter tuning job was created.

hyperParameterTuningJobSearchEntity_failureReason :: Lens' HyperParameterTuningJobSearchEntity (Maybe Text) Source #

The error that was created when a hyperparameter tuning job failed.

hyperParameterTuningJobSearchEntity_hyperParameterTuningEndTime :: Lens' HyperParameterTuningJobSearchEntity (Maybe UTCTime) Source #

The time that a hyperparameter tuning job ended.

hyperParameterTuningJobSearchEntity_hyperParameterTuningJobArn :: Lens' HyperParameterTuningJobSearchEntity (Maybe Text) Source #

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

hyperParameterTuningJobSearchEntity_hyperParameterTuningJobConfig :: Lens' HyperParameterTuningJobSearchEntity (Maybe HyperParameterTuningJobConfig) Source #

Undocumented member.

hyperParameterTuningJobSearchEntity_hyperParameterTuningJobName :: Lens' HyperParameterTuningJobSearchEntity (Maybe Text) Source #

The name of a hyperparameter tuning job.

hyperParameterTuningJobSearchEntity_hyperParameterTuningJobStatus :: Lens' HyperParameterTuningJobSearchEntity (Maybe HyperParameterTuningJobStatus) Source #

The status of a hyperparameter tuning job.

hyperParameterTuningJobSearchEntity_lastModifiedTime :: Lens' HyperParameterTuningJobSearchEntity (Maybe UTCTime) Source #

The time that a hyperparameter tuning job was last modified.

hyperParameterTuningJobSearchEntity_objectiveStatusCounters :: Lens' HyperParameterTuningJobSearchEntity (Maybe ObjectiveStatusCounters) Source #

Undocumented member.

hyperParameterTuningJobSearchEntity_overallBestTrainingJob :: Lens' HyperParameterTuningJobSearchEntity (Maybe HyperParameterTrainingJobSummary) Source #

Undocumented member.

hyperParameterTuningJobSearchEntity_tags :: Lens' HyperParameterTuningJobSearchEntity (Maybe [Tag]) Source #

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

hyperParameterTuningJobSearchEntity_trainingJobDefinition :: Lens' HyperParameterTuningJobSearchEntity (Maybe HyperParameterTrainingJobDefinition) Source #

Undocumented member.

hyperParameterTuningJobSearchEntity_trainingJobDefinitions :: Lens' HyperParameterTuningJobSearchEntity (Maybe (NonEmpty HyperParameterTrainingJobDefinition)) Source #

The job definitions included in a hyperparameter tuning job.

hyperParameterTuningJobSearchEntity_trainingJobStatusCounters :: Lens' HyperParameterTuningJobSearchEntity (Maybe TrainingJobStatusCounters) Source #

Undocumented member.

hyperParameterTuningJobSearchEntity_warmStartConfig :: Lens' HyperParameterTuningJobSearchEntity (Maybe HyperParameterTuningJobWarmStartConfig) Source #

Undocumented member.

HyperParameterTuningJobStrategyConfig

hyperParameterTuningJobStrategyConfig_hyperbandStrategyConfig :: Lens' HyperParameterTuningJobStrategyConfig (Maybe HyperbandStrategyConfig) Source #

The configuration for the object that specifies the Hyperband strategy. This parameter is only supported for the Hyperband selection for Strategy within the HyperParameterTuningJobConfig API.

HyperParameterTuningJobSummary

hyperParameterTuningJobSummary_hyperParameterTuningEndTime :: Lens' HyperParameterTuningJobSummary (Maybe UTCTime) Source #

The date and time that the tuning job ended.

hyperParameterTuningJobSummary_lastModifiedTime :: Lens' HyperParameterTuningJobSummary (Maybe UTCTime) Source #

The date and time that the tuning job was modified.

hyperParameterTuningJobSummary_resourceLimits :: Lens' HyperParameterTuningJobSummary (Maybe ResourceLimits) Source #

The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

hyperParameterTuningJobSummary_hyperParameterTuningJobName :: Lens' HyperParameterTuningJobSummary Text Source #

The name of the tuning job.

hyperParameterTuningJobSummary_hyperParameterTuningJobArn :: Lens' HyperParameterTuningJobSummary Text Source #

The Amazon Resource Name (ARN) of the tuning job.

hyperParameterTuningJobSummary_hyperParameterTuningJobStatus :: Lens' HyperParameterTuningJobSummary HyperParameterTuningJobStatus Source #

The status of the tuning job.

hyperParameterTuningJobSummary_strategy :: Lens' HyperParameterTuningJobSummary HyperParameterTuningJobStrategyType Source #

Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to evaluate at each iteration.

hyperParameterTuningJobSummary_creationTime :: Lens' HyperParameterTuningJobSummary UTCTime Source #

The date and time that the tuning job was created.

hyperParameterTuningJobSummary_trainingJobStatusCounters :: Lens' HyperParameterTuningJobSummary TrainingJobStatusCounters Source #

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

hyperParameterTuningJobSummary_objectiveStatusCounters :: Lens' HyperParameterTuningJobSummary ObjectiveStatusCounters Source #

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

HyperParameterTuningJobWarmStartConfig

hyperParameterTuningJobWarmStartConfig_parentHyperParameterTuningJobs :: Lens' HyperParameterTuningJobWarmStartConfig (NonEmpty ParentHyperParameterTuningJob) Source #

An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

hyperParameterTuningJobWarmStartConfig_warmStartType :: Lens' HyperParameterTuningJobWarmStartConfig HyperParameterTuningJobWarmStartType Source #

Specifies one of the following:

IDENTICAL_DATA_AND_ALGORITHM
The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.
TRANSFER_LEARNING
The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

HyperParameterTuningResourceConfig

hyperParameterTuningResourceConfig_allocationStrategy :: Lens' HyperParameterTuningResourceConfig (Maybe HyperParameterTuningAllocationStrategy) Source #

The strategy that determines the order of preference for resources specified in InstanceConfigs used in hyperparameter optimization.

hyperParameterTuningResourceConfig_instanceConfigs :: Lens' HyperParameterTuningResourceConfig (Maybe (NonEmpty HyperParameterTuningInstanceConfig)) Source #

A list containing the configuration(s) for one or more resources for processing hyperparameter jobs. These resources include compute instances and storage volumes to use in model training jobs launched by hyperparameter tuning jobs. The AllocationStrategy controls the order in which multiple configurations provided in InstanceConfigs are used.

If you only want to use a single instance configuration inside the HyperParameterTuningResourceConfig API, do not provide a value for InstanceConfigs. Instead, use InstanceType, VolumeSizeInGB and InstanceCount. If you use InstanceConfigs, do not provide values for InstanceType, VolumeSizeInGB or InstanceCount.

hyperParameterTuningResourceConfig_instanceCount :: Lens' HyperParameterTuningResourceConfig (Maybe Natural) Source #

The number of compute instances of type InstanceType to use. For distributed training, select a value greater than 1.

hyperParameterTuningResourceConfig_instanceType :: Lens' HyperParameterTuningResourceConfig (Maybe TrainingInstanceType) Source #

The instance type used to run hyperparameter optimization tuning jobs. See descriptions of instance types for more information.

hyperParameterTuningResourceConfig_volumeKmsKeyId :: Lens' HyperParameterTuningResourceConfig (Maybe Text) Source #

A key used by Amazon Web Services Key Management Service to encrypt data on the storage volume attached to the compute instances used to run the training job. You can use either of the following formats to specify a key.

KMS Key ID:

"1234abcd-12ab-34cd-56ef-1234567890ab"

Amazon Resource Name (ARN) of a KMS key:

"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

Some instances use local storage, which use a hardware module to encrypt storage volumes. If you choose one of these instance types, you cannot request a VolumeKmsKeyId. For a list of instance types that use local storage, see instance store volumes. For more information about Amazon Web Services Key Management Service, see KMS encryption for more information.

hyperParameterTuningResourceConfig_volumeSizeInGB :: Lens' HyperParameterTuningResourceConfig (Maybe Natural) Source #

The volume size in GB for the storage volume to be used in processing hyperparameter optimization jobs (optional). These volumes store model artifacts, incremental states and optionally, scratch space for training algorithms. Do not provide a value for this parameter if a value for InstanceConfigs is also specified.

Some instance types have a fixed total local storage size. If you select one of these instances for training, VolumeSizeInGB cannot be greater than this total size. For a list of instance types with local instance storage and their sizes, see instance store volumes.

SageMaker supports only the General Purpose SSD (gp2) storage volume type.

HyperbandStrategyConfig

hyperbandStrategyConfig_maxResource :: Lens' HyperbandStrategyConfig (Maybe Natural) Source #

The maximum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. Once a job reaches the MaxResource value, it is stopped. If a value for MaxResource is not provided, and Hyperband is selected as the hyperparameter tuning strategy, HyperbandTrainingJ attempts to infer MaxResource from the following keys (if present) in StaticsHyperParameters:

  • epochs
  • numepochs
  • n-epochs
  • n_epochs
  • num_epochs

If HyperbandStrategyConfig is unable to infer a value for MaxResource, it generates a validation error. The maximum value is 20,000 epochs. All metrics that correspond to an objective metric are used to derive early stopping decisions. For distributive training jobs, ensure that duplicate metrics are not printed in the logs across the individual nodes in a training job. If multiple nodes are publishing duplicate or incorrect metrics, training jobs may make an incorrect stopping decision and stop the job prematurely.

hyperbandStrategyConfig_minResource :: Lens' HyperbandStrategyConfig (Maybe Natural) Source #

The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource has not been reached, the training job will not be stopped by Hyperband.

Image

image_description :: Lens' Image (Maybe Text) Source #

The description of the image.

image_displayName :: Lens' Image (Maybe Text) Source #

The name of the image as displayed.

image_failureReason :: Lens' Image (Maybe Text) Source #

When a create, update, or delete operation fails, the reason for the failure.

image_creationTime :: Lens' Image UTCTime Source #

When the image was created.

image_imageArn :: Lens' Image Text Source #

The ARN of the image.

image_imageName :: Lens' Image Text Source #

The name of the image.

image_imageStatus :: Lens' Image ImageStatus Source #

The status of the image.

image_lastModifiedTime :: Lens' Image UTCTime Source #

When the image was last modified.

ImageConfig

imageConfig_repositoryAuthConfig :: Lens' ImageConfig (Maybe RepositoryAuthConfig) Source #

(Optional) Specifies an authentication configuration for the private docker registry where your model image is hosted. Specify a value for this property only if you specified Vpc as the value for the RepositoryAccessMode field, and the private Docker registry where the model image is hosted requires authentication.

imageConfig_repositoryAccessMode :: Lens' ImageConfig RepositoryAccessMode Source #

Set this to one of the following values:

  • Platform - The model image is hosted in Amazon ECR.
  • Vpc - The model image is hosted in a private Docker registry in your VPC.

ImageVersion

imageVersion_failureReason :: Lens' ImageVersion (Maybe Text) Source #

When a create or delete operation fails, the reason for the failure.

imageVersion_creationTime :: Lens' ImageVersion UTCTime Source #

When the version was created.

imageVersion_imageArn :: Lens' ImageVersion Text Source #

The ARN of the image the version is based on.

imageVersion_imageVersionArn :: Lens' ImageVersion Text Source #

The ARN of the version.

imageVersion_imageVersionStatus :: Lens' ImageVersion ImageVersionStatus Source #

The status of the version.

imageVersion_lastModifiedTime :: Lens' ImageVersion UTCTime Source #

When the version was last modified.

imageVersion_version :: Lens' ImageVersion Natural Source #

The version number.

InferenceExecutionConfig

inferenceExecutionConfig_mode :: Lens' InferenceExecutionConfig InferenceExecutionMode Source #

How containers in a multi-container are run. The following values are valid.

  • SERIAL - Containers run as a serial pipeline.
  • DIRECT - Only the individual container that you specify is run.

InferenceExperimentDataStorageConfig

inferenceExperimentDataStorageConfig_contentType :: Lens' InferenceExperimentDataStorageConfig (Maybe CaptureContentTypeHeader) Source #

Undocumented member.

inferenceExperimentDataStorageConfig_kmsKey :: Lens' InferenceExperimentDataStorageConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service key that Amazon SageMaker uses to encrypt captured data at rest using Amazon S3 server-side encryption.

inferenceExperimentDataStorageConfig_destination :: Lens' InferenceExperimentDataStorageConfig Text Source #

The Amazon S3 bucket where the inference request and response data is stored.

InferenceExperimentSchedule

inferenceExperimentSchedule_endTime :: Lens' InferenceExperimentSchedule (Maybe UTCTime) Source #

The timestamp at which the inference experiment ended or will end.

inferenceExperimentSchedule_startTime :: Lens' InferenceExperimentSchedule (Maybe UTCTime) Source #

The timestamp at which the inference experiment started or will start.

InferenceExperimentSummary

inferenceExperimentSummary_completionTime :: Lens' InferenceExperimentSummary (Maybe UTCTime) Source #

The timestamp at which the inference experiment was completed.

inferenceExperimentSummary_description :: Lens' InferenceExperimentSummary (Maybe Text) Source #

The description of the inference experiment.

inferenceExperimentSummary_roleArn :: Lens' InferenceExperimentSummary (Maybe Text) Source #

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.

inferenceExperimentSummary_schedule :: Lens' InferenceExperimentSummary (Maybe InferenceExperimentSchedule) Source #

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.

inferenceExperimentSummary_statusReason :: Lens' InferenceExperimentSummary (Maybe Text) Source #

The error message for the inference experiment status result.

inferenceExperimentSummary_name :: Lens' InferenceExperimentSummary Text Source #

The name of the inference experiment.

inferenceExperimentSummary_type :: Lens' InferenceExperimentSummary InferenceExperimentType Source #

The type of the inference experiment.

inferenceExperimentSummary_status :: Lens' InferenceExperimentSummary InferenceExperimentStatus Source #

The status of the inference experiment.

inferenceExperimentSummary_creationTime :: Lens' InferenceExperimentSummary UTCTime Source #

The timestamp at which the inference experiment was created.

inferenceExperimentSummary_lastModifiedTime :: Lens' InferenceExperimentSummary UTCTime Source #

The timestamp when you last modified the inference experiment.

InferenceMetrics

inferenceMetrics_maxInvocations :: Lens' InferenceMetrics Int Source #

The expected maximum number of requests per minute for the instance.

inferenceMetrics_modelLatency :: Lens' InferenceMetrics Int Source #

The expected model latency at maximum invocations per minute for the instance.

InferenceRecommendation

inferenceRecommendation_metrics :: Lens' InferenceRecommendation RecommendationMetrics Source #

The metrics used to decide what recommendation to make.

inferenceRecommendation_endpointConfiguration :: Lens' InferenceRecommendation EndpointOutputConfiguration Source #

Defines the endpoint configuration parameters.

inferenceRecommendation_modelConfiguration :: Lens' InferenceRecommendation ModelConfiguration Source #

Defines the model configuration.

InferenceRecommendationsJob

inferenceRecommendationsJob_completionTime :: Lens' InferenceRecommendationsJob (Maybe UTCTime) Source #

A timestamp that shows when the job completed.

inferenceRecommendationsJob_failureReason :: Lens' InferenceRecommendationsJob (Maybe Text) Source #

If the job fails, provides information why the job failed.

inferenceRecommendationsJob_jobName :: Lens' InferenceRecommendationsJob Text Source #

The name of the job.

inferenceRecommendationsJob_jobDescription :: Lens' InferenceRecommendationsJob Text Source #

The job description.

inferenceRecommendationsJob_jobType :: Lens' InferenceRecommendationsJob RecommendationJobType Source #

The recommendation job type.

inferenceRecommendationsJob_jobArn :: Lens' InferenceRecommendationsJob Text Source #

The Amazon Resource Name (ARN) of the recommendation job.

inferenceRecommendationsJob_status :: Lens' InferenceRecommendationsJob RecommendationJobStatus Source #

The status of the job.

inferenceRecommendationsJob_creationTime :: Lens' InferenceRecommendationsJob UTCTime Source #

A timestamp that shows when the job was created.

inferenceRecommendationsJob_roleArn :: Lens' InferenceRecommendationsJob Text Source #

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

inferenceRecommendationsJob_lastModifiedTime :: Lens' InferenceRecommendationsJob UTCTime Source #

A timestamp that shows when the job was last modified.

InferenceRecommendationsJobStep

inferenceRecommendationsJobStep_inferenceBenchmark :: Lens' InferenceRecommendationsJobStep (Maybe RecommendationJobInferenceBenchmark) Source #

The details for a specific benchmark.

inferenceRecommendationsJobStep_stepType :: Lens' InferenceRecommendationsJobStep RecommendationStepType Source #

The type of the subtask.

BENCHMARK: Evaluate the performance of your model on different instance types.

inferenceRecommendationsJobStep_jobName :: Lens' InferenceRecommendationsJobStep Text Source #

The name of the Inference Recommender job.

inferenceRecommendationsJobStep_status :: Lens' InferenceRecommendationsJobStep RecommendationJobStatus Source #

The current status of the benchmark.

InferenceSpecification

inferenceSpecification_supportedRealtimeInferenceInstanceTypes :: Lens' InferenceSpecification (Maybe [ProductionVariantInstanceType]) Source #

A list of the instance types that are used to generate inferences in real-time.

This parameter is required for unversioned models, and optional for versioned models.

inferenceSpecification_supportedTransformInstanceTypes :: Lens' InferenceSpecification (Maybe (NonEmpty TransformInstanceType)) Source #

A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

This parameter is required for unversioned models, and optional for versioned models.

inferenceSpecification_containers :: Lens' InferenceSpecification (NonEmpty ModelPackageContainerDefinition) Source #

The Amazon ECR registry path of the Docker image that contains the inference code.

inferenceSpecification_supportedContentTypes :: Lens' InferenceSpecification [Text] Source #

The supported MIME types for the input data.

inferenceSpecification_supportedResponseMIMETypes :: Lens' InferenceSpecification [Text] Source #

The supported MIME types for the output data.

InputConfig

inputConfig_frameworkVersion :: Lens' InputConfig (Maybe Text) Source #

Specifies the framework version to use. This API field is only supported for the MXNet, PyTorch, TensorFlow and TensorFlow Lite frameworks.

For information about framework versions supported for cloud targets and edge devices, see Cloud Supported Instance Types and Frameworks and Edge Supported Frameworks.

inputConfig_s3Uri :: Lens' InputConfig Text Source #

The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

inputConfig_dataInputConfig :: Lens' InputConfig Text Source #

Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

  • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input":[1,1024,1024,3]}
      • If using the CLI, {\"input\":[1,1024,1024,3]}

    • Examples for two inputs:

      • If using the console, {"data1": [1,28,28,1], "data2":[1,28,28,1]}
      • If using the CLI, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

  • KERAS: You must specify the name and shape (NCHW format) of expected data inputs using a dictionary format for your trained model. Note that while Keras model artifacts should be uploaded in NHWC (channel-last) format, DataInputConfig should be specified in NCHW (channel-first) format. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"input_1":[1,3,224,224]}
      • If using the CLI, {\"input_1\":[1,3,224,224]}

    • Examples for two inputs:

      • If using the console, {"input_1": [1,3,224,224], "input_2":[1,3,224,224]}
      • If using the CLI, {\"input_1\": [1,3,224,224], \"input_2\":[1,3,224,224]}

  • MXNET/ONNX/DARKNET: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

    • Examples for one input:

      • If using the console, {"data":[1,3,1024,1024]}
      • If using the CLI, {\"data\":[1,3,1024,1024]}

    • Examples for two inputs:

      • If using the console, {"var1": [1,1,28,28], "var2":[1,1,28,28]}
      • If using the CLI, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

  • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

    • Examples for one input in dictionary format:

      • If using the console, {"input0":[1,3,224,224]}
      • If using the CLI, {\"input0\":[1,3,224,224]}
    • Example for one input in list format: [[1,3,224,224]]

    • Examples for two inputs in dictionary format:

      • If using the console, {"input0":[1,3,224,224], "input1":[1,3,224,224]}
      • If using the CLI, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}
    • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]
  • XGBOOST: input data name and shape are not needed.

DataInputConfig supports the following parameters for CoreML OutputConfig$TargetDevice (ML Model format):

  • shape: Input shape, for example {"input_1": {"shape": [1,224,224,3]}}. In addition to static input shapes, CoreML converter supports Flexible input shapes:

    • Range Dimension. You can use the Range Dimension feature if you know the input shape will be within some specific interval in that dimension, for example: {"input_1": {"shape": ["1..10", 224, 224, 3]}}
    • Enumerated shapes. Sometimes, the models are trained to work only on a select set of inputs. You can enumerate all supported input shapes, for example: {"input_1": {"shape": [[1, 224, 224, 3], [1, 160, 160, 3]]}}
  • default_shape: Default input shape. You can set a default shape during conversion for both Range Dimension and Enumerated Shapes. For example {"input_1": {"shape": ["1..10", 224, 224, 3], "default_shape": [1, 224, 224, 3]}}
  • type: Input type. Allowed values: Image and Tensor. By default, the converter generates an ML Model with inputs of type Tensor (MultiArray). User can set input type to be Image. Image input type requires additional input parameters such as bias and scale.
  • bias: If the input type is an Image, you need to provide the bias vector.
  • scale: If the input type is an Image, you need to provide a scale factor.

CoreML ClassifierConfig parameters can be specified using OutputConfig$CompilerOptions. CoreML converter supports Tensorflow and PyTorch models. CoreML conversion examples:

  • Tensor type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3]}}

  • Tensor type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224]}]

  • Image type input:

    • "DataInputConfig": {"input_1": {"shape": [[1,224,224,3], [1,160,160,3]], "default_shape": [1,224,224,3], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}}
    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

  • Image type input without input name (PyTorch):

    • "DataInputConfig": [{"shape": [[1,3,224,224], [1,3,160,160]], "default_shape": [1,3,224,224], "type": "Image", "bias": [-1,-1,-1], "scale": 0.007843137255}]
    • "CompilerOptions": {"class_labels": "imagenet_labels_1000.txt"}

Depending on the model format, DataInputConfig requires the following parameters for ml_eia2 OutputConfig:TargetDevice.

  • For TensorFlow models saved in the SavedModel format, specify the input names from signature_def_key and the input model shapes for DataInputConfig. Specify the signature_def_key in OutputConfig:CompilerOptions if the model does not use TensorFlow's default signature def key. For example:

    • "DataInputConfig": {"inputs": [1, 224, 224, 3]}
    • "CompilerOptions": {"signature_def_key": "serving_custom"}

  • For TensorFlow models saved as a frozen graph, specify the input tensor names and shapes in DataInputConfig and the output tensor names for output_names in OutputConfig:CompilerOptions . For example:

    • "DataInputConfig": {"input_tensor:0": [1, 224, 224, 3]}
    • "CompilerOptions": {"output_names": ["output_tensor:0"]}

inputConfig_framework :: Lens' InputConfig Framework Source #

Identifies the framework in which the model was trained. For example: TENSORFLOW.

InstanceGroup

instanceGroup_instanceType :: Lens' InstanceGroup TrainingInstanceType Source #

Specifies the instance type of the instance group.

instanceGroup_instanceCount :: Lens' InstanceGroup Natural Source #

Specifies the number of instances of the instance group.

instanceGroup_instanceGroupName :: Lens' InstanceGroup Text Source #

Specifies the name of the instance group.

InstanceMetadataServiceConfiguration

instanceMetadataServiceConfiguration_minimumInstanceMetadataServiceVersion :: Lens' InstanceMetadataServiceConfiguration Text Source #

Indicates the minimum IMDS version that the notebook instance supports. When passed as part of CreateNotebookInstance, if no value is selected, then it defaults to IMDSv1. This means that both IMDSv1 and IMDSv2 are supported. If passed as part of UpdateNotebookInstance, there is no default.

IntegerParameterRange

integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe HyperParameterScalingType) Source #

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto
SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.
Linear
Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
Logarithmic
Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

integerParameterRange_name :: Lens' IntegerParameterRange Text Source #

The name of the hyperparameter to search.

integerParameterRange_minValue :: Lens' IntegerParameterRange Text Source #

The minimum value of the hyperparameter to search.

integerParameterRange_maxValue :: Lens' IntegerParameterRange Text Source #

The maximum value of the hyperparameter to search.

IntegerParameterRangeSpecification

integerParameterRangeSpecification_minValue :: Lens' IntegerParameterRangeSpecification Text Source #

The minimum integer value allowed.

integerParameterRangeSpecification_maxValue :: Lens' IntegerParameterRangeSpecification Text Source #

The maximum integer value allowed.

JupyterServerAppSettings

jupyterServerAppSettings_codeRepositories :: Lens' JupyterServerAppSettings (Maybe [CodeRepository]) Source #

A list of Git repositories that SageMaker automatically displays to users for cloning in the JupyterServer application.

jupyterServerAppSettings_defaultResourceSpec :: Lens' JupyterServerAppSettings (Maybe ResourceSpec) Source #

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the JupyterServer app. If you use the LifecycleConfigArns parameter, then this parameter is also required.

jupyterServerAppSettings_lifecycleConfigArns :: Lens' JupyterServerAppSettings (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the JupyterServerApp. If you use this parameter, the DefaultResourceSpec parameter is also required.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

KernelGatewayAppSettings

kernelGatewayAppSettings_customImages :: Lens' KernelGatewayAppSettings (Maybe [CustomImage]) Source #

A list of custom SageMaker images that are configured to run as a KernelGateway app.

kernelGatewayAppSettings_defaultResourceSpec :: Lens' KernelGatewayAppSettings (Maybe ResourceSpec) Source #

The default instance type and the Amazon Resource Name (ARN) of the default SageMaker image used by the KernelGateway app.

The Amazon SageMaker Studio UI does not use the default instance type value set here. The default instance type set here is used when Apps are created using the Amazon Web Services Command Line Interface or Amazon Web Services CloudFormation and the instance type parameter value is not passed.

kernelGatewayAppSettings_lifecycleConfigArns :: Lens' KernelGatewayAppSettings (Maybe [Text]) Source #

The Amazon Resource Name (ARN) of the Lifecycle Configurations attached to the the user profile or domain.

To remove a Lifecycle Config, you must set LifecycleConfigArns to an empty list.

KernelGatewayImageConfig

kernelGatewayImageConfig_fileSystemConfig :: Lens' KernelGatewayImageConfig (Maybe FileSystemConfig) Source #

The Amazon Elastic File System (EFS) storage configuration for a SageMaker image.

kernelGatewayImageConfig_kernelSpecs :: Lens' KernelGatewayImageConfig (NonEmpty KernelSpec) Source #

The specification of the Jupyter kernels in the image.

KernelSpec

kernelSpec_displayName :: Lens' KernelSpec (Maybe Text) Source #

The display name of the kernel.

kernelSpec_name :: Lens' KernelSpec Text Source #

The name of the Jupyter kernel in the image. This value is case sensitive.

LabelCounters

labelCounters_failedNonRetryableError :: Lens' LabelCounters (Maybe Natural) Source #

The total number of objects that could not be labeled due to an error.

labelCounters_humanLabeled :: Lens' LabelCounters (Maybe Natural) Source #

The total number of objects labeled by a human worker.

labelCounters_machineLabeled :: Lens' LabelCounters (Maybe Natural) Source #

The total number of objects labeled by automated data labeling.

labelCounters_totalLabeled :: Lens' LabelCounters (Maybe Natural) Source #

The total number of objects labeled.

labelCounters_unlabeled :: Lens' LabelCounters (Maybe Natural) Source #

The total number of objects not yet labeled.

LabelCountersForWorkteam

labelCountersForWorkteam_humanLabeled :: Lens' LabelCountersForWorkteam (Maybe Natural) Source #

The total number of data objects labeled by a human worker.

labelCountersForWorkteam_pendingHuman :: Lens' LabelCountersForWorkteam (Maybe Natural) Source #

The total number of data objects that need to be labeled by a human worker.

labelCountersForWorkteam_total :: Lens' LabelCountersForWorkteam (Maybe Natural) Source #

The total number of tasks in the labeling job.

LabelingJobAlgorithmsConfig

labelingJobAlgorithmsConfig_initialActiveLearningModelArn :: Lens' LabelingJobAlgorithmsConfig (Maybe Text) Source #

At the end of an auto-label job Ground Truth sends the Amazon Resource Name (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

labelingJobAlgorithmsConfig_labelingJobResourceConfig :: Lens' LabelingJobAlgorithmsConfig (Maybe LabelingJobResourceConfig) Source #

Provides configuration information for a labeling job.

labelingJobAlgorithmsConfig_labelingJobAlgorithmSpecificationArn :: Lens' LabelingJobAlgorithmsConfig Text Source #

Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

  • Image classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

  • Text classification

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

  • Object detection

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

  • Semantic Segmentation

    arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

LabelingJobDataAttributes

labelingJobDataAttributes_contentClassifiers :: Lens' LabelingJobDataAttributes (Maybe [ContentClassifier]) Source #

Declares that your content is free of personally identifiable information or adult content. SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

LabelingJobDataSource

labelingJobDataSource_s3DataSource :: Lens' LabelingJobDataSource (Maybe LabelingJobS3DataSource) Source #

The Amazon S3 location of the input data objects.

labelingJobDataSource_snsDataSource :: Lens' LabelingJobDataSource (Maybe LabelingJobSnsDataSource) Source #

An Amazon SNS data source used for streaming labeling jobs. To learn more, see Send Data to a Streaming Labeling Job.

LabelingJobForWorkteamSummary

labelingJobForWorkteamSummary_labelCounters :: Lens' LabelingJobForWorkteamSummary (Maybe LabelCountersForWorkteam) Source #

Provides information about the progress of a labeling job.

labelingJobForWorkteamSummary_labelingJobName :: Lens' LabelingJobForWorkteamSummary (Maybe Text) Source #

The name of the labeling job that the work team is assigned to.

labelingJobForWorkteamSummary_numberOfHumanWorkersPerDataObject :: Lens' LabelingJobForWorkteamSummary (Maybe Natural) Source #

The configured number of workers per data object.

labelingJobForWorkteamSummary_jobReferenceCode :: Lens' LabelingJobForWorkteamSummary Text Source #

A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

labelingJobForWorkteamSummary_workRequesterAccountId :: Lens' LabelingJobForWorkteamSummary Text Source #

The Amazon Web Services account ID of the account used to start the labeling job.

labelingJobForWorkteamSummary_creationTime :: Lens' LabelingJobForWorkteamSummary UTCTime Source #

The date and time that the labeling job was created.

LabelingJobInputConfig

labelingJobInputConfig_dataAttributes :: Lens' LabelingJobInputConfig (Maybe LabelingJobDataAttributes) Source #

Attributes of the data specified by the customer.

labelingJobInputConfig_dataSource :: Lens' LabelingJobInputConfig LabelingJobDataSource Source #

The location of the input data.

LabelingJobOutput

labelingJobOutput_finalActiveLearningModelArn :: Lens' LabelingJobOutput (Maybe Text) Source #

The Amazon Resource Name (ARN) for the most recent SageMaker model trained as part of automated data labeling.

labelingJobOutput_outputDatasetS3Uri :: Lens' LabelingJobOutput Text Source #

The Amazon S3 bucket location of the manifest file for labeled data.

LabelingJobOutputConfig

labelingJobOutputConfig_kmsKeyId :: Lens' LabelingJobOutputConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service ID of the key used to encrypt the output data, if any.

If you provide your own KMS key ID, you must add the required permissions to your KMS key described in Encrypt Output Data and Storage Volume with Amazon Web Services KMS.

If you don't provide a KMS key ID, Amazon SageMaker uses the default Amazon Web Services KMS key for Amazon S3 for your role's account to encrypt your output data.

If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

labelingJobOutputConfig_snsTopicArn :: Lens' LabelingJobOutputConfig (Maybe Text) Source #

An Amazon Simple Notification Service (Amazon SNS) output topic ARN. Provide a SnsTopicArn if you want to do real time chaining to another streaming job and receive an Amazon SNS notifications each time a data object is submitted by a worker.

If you provide an SnsTopicArn in OutputConfig, when workers complete labeling tasks, Ground Truth will send labeling task output data to the SNS output topic you specify here.

To learn more, see Receive Output Data from a Streaming Labeling Job.

labelingJobOutputConfig_s3OutputPath :: Lens' LabelingJobOutputConfig Text Source #

The Amazon S3 location to write output data.

LabelingJobResourceConfig

labelingJobResourceConfig_volumeKmsKeyId :: Lens' LabelingJobResourceConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training and inference jobs used for automated data labeling.

You can only specify a VolumeKmsKeyId when you create a labeling job with automated data labeling enabled using the API operation CreateLabelingJob. You cannot specify an Amazon Web Services KMS key to encrypt the storage volume used for automated data labeling model training and inference when you create a labeling job using the console. To learn more, see Output Data and Storage Volume Encryption.

The VolumeKmsKeyId can be any of the following formats:

  • KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

labelingJobResourceConfig_vpcConfig :: Lens' LabelingJobResourceConfig (Maybe VpcConfig) Source #

Undocumented member.

LabelingJobS3DataSource

labelingJobS3DataSource_manifestS3Uri :: Lens' LabelingJobS3DataSource Text Source #

The Amazon S3 location of the manifest file that describes the input data objects.

The input manifest file referenced in ManifestS3Uri must contain one of the following keys: source-ref or source. The value of the keys are interpreted as follows:

  • source-ref: The source of the object is the Amazon S3 object specified in the value. Use this value when the object is a binary object, such as an image.
  • source: The source of the object is the value. Use this value when the object is a text value.

If you are a new user of Ground Truth, it is recommended you review Use an Input Manifest File in the Amazon SageMaker Developer Guide to learn how to create an input manifest file.

LabelingJobSnsDataSource

labelingJobSnsDataSource_snsTopicArn :: Lens' LabelingJobSnsDataSource Text Source #

The Amazon SNS input topic Amazon Resource Name (ARN). Specify the ARN of the input topic you will use to send new data objects to a streaming labeling job.

LabelingJobStoppingConditions

labelingJobStoppingConditions_maxHumanLabeledObjectCount :: Lens' LabelingJobStoppingConditions (Maybe Natural) Source #

The maximum number of objects that can be labeled by human workers.

labelingJobStoppingConditions_maxPercentageOfInputDatasetLabeled :: Lens' LabelingJobStoppingConditions (Maybe Natural) Source #

The maximum number of input data objects that should be labeled.

LabelingJobSummary

labelingJobSummary_annotationConsolidationLambdaArn :: Lens' LabelingJobSummary (Maybe Text) Source #

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.

labelingJobSummary_failureReason :: Lens' LabelingJobSummary (Maybe Text) Source #

If the LabelingJobStatus field is Failed, this field contains a description of the error.

labelingJobSummary_inputConfig :: Lens' LabelingJobSummary (Maybe LabelingJobInputConfig) Source #

Input configuration for the labeling job.

labelingJobSummary_labelingJobOutput :: Lens' LabelingJobSummary (Maybe LabelingJobOutput) Source #

The location of the output produced by the labeling job.

labelingJobSummary_labelingJobName :: Lens' LabelingJobSummary Text Source #

The name of the labeling job.

labelingJobSummary_labelingJobArn :: Lens' LabelingJobSummary Text Source #

The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

labelingJobSummary_creationTime :: Lens' LabelingJobSummary UTCTime Source #

The date and time that the job was created (timestamp).

labelingJobSummary_lastModifiedTime :: Lens' LabelingJobSummary UTCTime Source #

The date and time that the job was last modified (timestamp).

labelingJobSummary_labelingJobStatus :: Lens' LabelingJobSummary LabelingJobStatus Source #

The current status of the labeling job.

labelingJobSummary_labelCounters :: Lens' LabelingJobSummary LabelCounters Source #

Counts showing the progress of the labeling job.

labelingJobSummary_workteamArn :: Lens' LabelingJobSummary Text Source #

The Amazon Resource Name (ARN) of the work team assigned to the job.

labelingJobSummary_preHumanTaskLambdaArn :: Lens' LabelingJobSummary Text Source #

The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

LambdaStepMetadata

lambdaStepMetadata_arn :: Lens' LambdaStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution.

lambdaStepMetadata_outputParameters :: Lens' LambdaStepMetadata (Maybe [OutputParameter]) Source #

A list of the output parameters of the Lambda step.

LastUpdateStatus

lastUpdateStatus_failureReason :: Lens' LastUpdateStatus (Maybe Text) Source #

If the update wasn't successful, indicates the reason why it failed.

lastUpdateStatus_status :: Lens' LastUpdateStatus LastUpdateStatusValue Source #

A value that indicates whether the update was made successful.

LineageGroupSummary

lineageGroupSummary_creationTime :: Lens' LineageGroupSummary (Maybe UTCTime) Source #

The creation time of the lineage group summary.

lineageGroupSummary_displayName :: Lens' LineageGroupSummary (Maybe Text) Source #

The display name of the lineage group summary.

lineageGroupSummary_lastModifiedTime :: Lens' LineageGroupSummary (Maybe UTCTime) Source #

The last modified time of the lineage group summary.

lineageGroupSummary_lineageGroupArn :: Lens' LineageGroupSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group resource.

lineageGroupSummary_lineageGroupName :: Lens' LineageGroupSummary (Maybe Text) Source #

The name or Amazon Resource Name (ARN) of the lineage group.

MemberDefinition

memberDefinition_cognitoMemberDefinition :: Lens' MemberDefinition (Maybe CognitoMemberDefinition) Source #

The Amazon Cognito user group that is part of the work team.

memberDefinition_oidcMemberDefinition :: Lens' MemberDefinition (Maybe OidcMemberDefinition) Source #

A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.

MetadataProperties

metadataProperties_commitId :: Lens' MetadataProperties (Maybe Text) Source #

The commit ID.

metadataProperties_generatedBy :: Lens' MetadataProperties (Maybe Text) Source #

The entity this entity was generated by.

metadataProperties_projectId :: Lens' MetadataProperties (Maybe Text) Source #

The project ID.

metadataProperties_repository :: Lens' MetadataProperties (Maybe Text) Source #

The repository.

MetricData

metricData_metricName :: Lens' MetricData (Maybe Text) Source #

The name of the metric.

metricData_timestamp :: Lens' MetricData (Maybe UTCTime) Source #

The date and time that the algorithm emitted the metric.

metricData_value :: Lens' MetricData (Maybe Double) Source #

The value of the metric.

MetricDatum

metricDatum_metricName :: Lens' MetricDatum (Maybe AutoMLMetricEnum) Source #

The name of the metric.

metricDatum_set :: Lens' MetricDatum (Maybe MetricSetSource) Source #

The dataset split from which the AutoML job produced the metric.

metricDatum_standardMetricName :: Lens' MetricDatum (Maybe AutoMLMetricExtendedEnum) Source #

The name of the standard metric.

For definitions of the standard metrics, see Autopilot candidate metrics .

metricDatum_value :: Lens' MetricDatum (Maybe Double) Source #

The value of the metric.

MetricDefinition

metricDefinition_name :: Lens' MetricDefinition Text Source #

The name of the metric.

metricDefinition_regex :: Lens' MetricDefinition Text Source #

A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

MetricsSource

metricsSource_contentDigest :: Lens' MetricsSource (Maybe Text) Source #

The hash key used for the metrics source.

metricsSource_contentType :: Lens' MetricsSource Text Source #

The metric source content type.

metricsSource_s3Uri :: Lens' MetricsSource Text Source #

The S3 URI for the metrics source.

Model

model_containers :: Lens' Model (Maybe [ContainerDefinition]) Source #

The containers in the inference pipeline.

model_creationTime :: Lens' Model (Maybe UTCTime) Source #

A timestamp that indicates when the model was created.

model_enableNetworkIsolation :: Lens' Model (Maybe Bool) Source #

Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

model_executionRoleArn :: Lens' Model (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

model_inferenceExecutionConfig :: Lens' Model (Maybe InferenceExecutionConfig) Source #

Undocumented member.

model_modelArn :: Lens' Model (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model.

model_modelName :: Lens' Model (Maybe Text) Source #

The name of the model.

model_primaryContainer :: Lens' Model (Maybe ContainerDefinition) Source #

Undocumented member.

model_tags :: Lens' Model (Maybe [Tag]) Source #

A list of key-value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

model_vpcConfig :: Lens' Model (Maybe VpcConfig) Source #

Undocumented member.

ModelArtifacts

modelArtifacts_s3ModelArtifacts :: Lens' ModelArtifacts Text Source #

The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

ModelBiasAppSpecification

modelBiasAppSpecification_environment :: Lens' ModelBiasAppSpecification (Maybe (HashMap Text Text)) Source #

Sets the environment variables in the Docker container.

modelBiasAppSpecification_imageUri :: Lens' ModelBiasAppSpecification Text Source #

The container image to be run by the model bias job.

modelBiasAppSpecification_configUri :: Lens' ModelBiasAppSpecification Text Source #

JSON formatted S3 file that defines bias parameters. For more information on this JSON configuration file, see Configure bias parameters.

ModelBiasBaselineConfig

modelBiasBaselineConfig_baseliningJobName :: Lens' ModelBiasBaselineConfig (Maybe Text) Source #

The name of the baseline model bias job.

modelBiasBaselineConfig_constraintsResource :: Lens' ModelBiasBaselineConfig (Maybe MonitoringConstraintsResource) Source #

Undocumented member.

ModelBiasJobInput

modelBiasJobInput_batchTransformInput :: Lens' ModelBiasJobInput (Maybe BatchTransformInput) Source #

Input object for the batch transform job.

modelBiasJobInput_endpointInput :: Lens' ModelBiasJobInput (Maybe EndpointInput) Source #

Undocumented member.

modelBiasJobInput_groundTruthS3Input :: Lens' ModelBiasJobInput MonitoringGroundTruthS3Input Source #

Location of ground truth labels to use in model bias job.

ModelCard

modelCard_content :: Lens' ModelCard (Maybe Text) Source #

The content of the model card. Content uses the model card JSON schema and provided as a string.

modelCard_createdBy :: Lens' ModelCard (Maybe UserContext) Source #

Undocumented member.

modelCard_creationTime :: Lens' ModelCard (Maybe UTCTime) Source #

The date and time that the model card was created.

modelCard_lastModifiedBy :: Lens' ModelCard (Maybe UserContext) Source #

Undocumented member.

modelCard_lastModifiedTime :: Lens' ModelCard (Maybe UTCTime) Source #

The date and time that the model card was last modified.

modelCard_modelCardArn :: Lens' ModelCard (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model card.

modelCard_modelCardName :: Lens' ModelCard (Maybe Text) Source #

The unique name of the model card.

modelCard_modelCardStatus :: Lens' ModelCard (Maybe ModelCardStatus) Source #

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.

modelCard_modelCardVersion :: Lens' ModelCard (Maybe Int) Source #

The version of the model card.

modelCard_modelId :: Lens' ModelCard (Maybe Text) Source #

The unique name (ID) of the model.

modelCard_riskRating :: Lens' ModelCard (Maybe Text) Source #

The risk rating of the model. Different organizations might have different criteria for model card risk ratings. For more information, see Risk ratings.

modelCard_securityConfig :: Lens' ModelCard (Maybe ModelCardSecurityConfig) Source #

The security configuration used to protect model card data.

modelCard_tags :: Lens' ModelCard (Maybe [Tag]) Source #

Key-value pairs used to manage metadata for the model card.

ModelCardExportArtifacts

modelCardExportArtifacts_s3ExportArtifacts :: Lens' ModelCardExportArtifacts Text Source #

The Amazon S3 URI of the exported model artifacts.

ModelCardExportJobSummary

modelCardExportJobSummary_modelCardExportJobName :: Lens' ModelCardExportJobSummary Text Source #

The name of the model card export job.

modelCardExportJobSummary_modelCardExportJobArn :: Lens' ModelCardExportJobSummary Text Source #

The Amazon Resource Name (ARN) of the model card export job.

modelCardExportJobSummary_status :: Lens' ModelCardExportJobSummary ModelCardExportJobStatus Source #

The completion status of the model card export job.

modelCardExportJobSummary_modelCardName :: Lens' ModelCardExportJobSummary Text Source #

The name of the model card that the export job exports.

modelCardExportJobSummary_modelCardVersion :: Lens' ModelCardExportJobSummary Int Source #

The version of the model card that the export job exports.

modelCardExportJobSummary_createdAt :: Lens' ModelCardExportJobSummary UTCTime Source #

The date and time that the model card export job was created.

modelCardExportJobSummary_lastModifiedAt :: Lens' ModelCardExportJobSummary UTCTime Source #

The date and time that the model card export job was last modified..

ModelCardExportOutputConfig

modelCardExportOutputConfig_s3OutputPath :: Lens' ModelCardExportOutputConfig Text Source #

The Amazon S3 output path to export your model card PDF.

ModelCardSecurityConfig

modelCardSecurityConfig_kmsKeyId :: Lens' ModelCardSecurityConfig (Maybe Text) Source #

A Key Management Service key ID to use for encrypting a model card.

ModelCardSummary

modelCardSummary_lastModifiedTime :: Lens' ModelCardSummary (Maybe UTCTime) Source #

The date and time that the model card was last modified.

modelCardSummary_modelCardName :: Lens' ModelCardSummary Text Source #

The name of the model card.

modelCardSummary_modelCardArn :: Lens' ModelCardSummary Text Source #

The Amazon Resource Name (ARN) of the model card.

modelCardSummary_modelCardStatus :: Lens' ModelCardSummary ModelCardStatus Source #

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.

modelCardSummary_creationTime :: Lens' ModelCardSummary UTCTime Source #

The date and time that the model card was created.

ModelCardVersionSummary

modelCardVersionSummary_lastModifiedTime :: Lens' ModelCardVersionSummary (Maybe UTCTime) Source #

The time date and time that the model card version was last modified.

modelCardVersionSummary_modelCardName :: Lens' ModelCardVersionSummary Text Source #

The name of the model card.

modelCardVersionSummary_modelCardArn :: Lens' ModelCardVersionSummary Text Source #

The Amazon Resource Name (ARN) of the model card.

modelCardVersionSummary_modelCardStatus :: Lens' ModelCardVersionSummary ModelCardStatus Source #

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.

modelCardVersionSummary_modelCardVersion :: Lens' ModelCardVersionSummary Int Source #

A version of the model card.

modelCardVersionSummary_creationTime :: Lens' ModelCardVersionSummary UTCTime Source #

The date and time that the model card version was created.

ModelClientConfig

modelClientConfig_invocationsMaxRetries :: Lens' ModelClientConfig (Maybe Natural) Source #

The maximum number of retries when invocation requests are failing. The default value is 3.

modelClientConfig_invocationsTimeoutInSeconds :: Lens' ModelClientConfig (Maybe Natural) Source #

The timeout value in seconds for an invocation request. The default value is 600.

ModelConfiguration

modelConfiguration_environmentParameters :: Lens' ModelConfiguration (Maybe (NonEmpty EnvironmentParameter)) Source #

Defines the environment parameters that includes key, value types, and values.

modelConfiguration_inferenceSpecificationName :: Lens' ModelConfiguration (Maybe Text) Source #

The inference specification name in the model package version.

ModelDashboardEndpoint

modelDashboardEndpoint_endpointName :: Lens' ModelDashboardEndpoint Text Source #

The endpoint name.

modelDashboardEndpoint_endpointArn :: Lens' ModelDashboardEndpoint Text Source #

The Amazon Resource Name (ARN) of the endpoint.

modelDashboardEndpoint_creationTime :: Lens' ModelDashboardEndpoint UTCTime Source #

A timestamp that indicates when the endpoint was created.

modelDashboardEndpoint_lastModifiedTime :: Lens' ModelDashboardEndpoint UTCTime Source #

The last time the endpoint was modified.

modelDashboardEndpoint_endpointStatus :: Lens' ModelDashboardEndpoint EndpointStatus Source #

The endpoint status.

ModelDashboardIndicatorAction

modelDashboardIndicatorAction_enabled :: Lens' ModelDashboardIndicatorAction (Maybe Bool) Source #

Indicates whether the alert action is turned on.

ModelDashboardModel

modelDashboardModel_endpoints :: Lens' ModelDashboardModel (Maybe [ModelDashboardEndpoint]) Source #

The endpoints that host a model.

modelDashboardModel_lastBatchTransformJob :: Lens' ModelDashboardModel (Maybe TransformJob) Source #

Undocumented member.

modelDashboardModel_model :: Lens' ModelDashboardModel (Maybe Model) Source #

A model displayed in the Model Dashboard.

modelDashboardModel_modelCard :: Lens' ModelDashboardModel (Maybe ModelDashboardModelCard) Source #

The model card for a model.

modelDashboardModel_monitoringSchedules :: Lens' ModelDashboardModel (Maybe [ModelDashboardMonitoringSchedule]) Source #

The monitoring schedules for a model.

ModelDashboardModelCard

modelDashboardModelCard_createdBy :: Lens' ModelDashboardModelCard (Maybe UserContext) Source #

Undocumented member.

modelDashboardModelCard_creationTime :: Lens' ModelDashboardModelCard (Maybe UTCTime) Source #

A timestamp that indicates when the model card was created.

modelDashboardModelCard_lastModifiedBy :: Lens' ModelDashboardModelCard (Maybe UserContext) Source #

Undocumented member.

modelDashboardModelCard_lastModifiedTime :: Lens' ModelDashboardModelCard (Maybe UTCTime) Source #

A timestamp that indicates when the model card was last updated.

modelDashboardModelCard_modelCardArn :: Lens' ModelDashboardModelCard (Maybe Text) Source #

The Amazon Resource Name (ARN) for a model card.

modelDashboardModelCard_modelCardName :: Lens' ModelDashboardModelCard (Maybe Text) Source #

The name of a model card.

modelDashboardModelCard_modelCardStatus :: Lens' ModelDashboardModelCard (Maybe ModelCardStatus) Source #

The model card status.

modelDashboardModelCard_modelCardVersion :: Lens' ModelDashboardModelCard (Maybe Int) Source #

The model card version.

modelDashboardModelCard_modelId :: Lens' ModelDashboardModelCard (Maybe Text) Source #

For models created in SageMaker, this is the model ARN. For models created outside of SageMaker, this is a user-customized string.

modelDashboardModelCard_riskRating :: Lens' ModelDashboardModelCard (Maybe Text) Source #

A model card's risk rating. Can be low, medium, or high.

modelDashboardModelCard_securityConfig :: Lens' ModelDashboardModelCard (Maybe ModelCardSecurityConfig) Source #

The KMS Key ID (KMSKeyId) for encryption of model card information.

modelDashboardModelCard_tags :: Lens' ModelDashboardModelCard (Maybe [Tag]) Source #

The tags associated with a model card.

ModelDashboardMonitoringSchedule

modelDashboardMonitoringSchedule_creationTime :: Lens' ModelDashboardMonitoringSchedule (Maybe UTCTime) Source #

A timestamp that indicates when the monitoring schedule was created.

modelDashboardMonitoringSchedule_endpointName :: Lens' ModelDashboardMonitoringSchedule (Maybe Text) Source #

The endpoint which is monitored.

modelDashboardMonitoringSchedule_failureReason :: Lens' ModelDashboardMonitoringSchedule (Maybe Text) Source #

If a monitoring job failed, provides the reason.

modelDashboardMonitoringSchedule_lastModifiedTime :: Lens' ModelDashboardMonitoringSchedule (Maybe UTCTime) Source #

A timestamp that indicates when the monitoring schedule was last updated.

modelDashboardMonitoringSchedule_lastMonitoringExecutionSummary :: Lens' ModelDashboardMonitoringSchedule (Maybe MonitoringExecutionSummary) Source #

Undocumented member.

modelDashboardMonitoringSchedule_monitoringAlertSummaries :: Lens' ModelDashboardMonitoringSchedule (Maybe (NonEmpty MonitoringAlertSummary)) Source #

A JSON array where each element is a summary for a monitoring alert.

modelDashboardMonitoringSchedule_monitoringScheduleArn :: Lens' ModelDashboardMonitoringSchedule (Maybe Text) Source #

The Amazon Resource Name (ARN) of a monitoring schedule.

modelDashboardMonitoringSchedule_monitoringScheduleConfig :: Lens' ModelDashboardMonitoringSchedule (Maybe MonitoringScheduleConfig) Source #

Undocumented member.

modelDashboardMonitoringSchedule_monitoringScheduleName :: Lens' ModelDashboardMonitoringSchedule (Maybe Text) Source #

The name of a monitoring schedule.

modelDashboardMonitoringSchedule_monitoringScheduleStatus :: Lens' ModelDashboardMonitoringSchedule (Maybe ScheduleStatus) Source #

The status of the monitoring schedule.

modelDashboardMonitoringSchedule_monitoringType :: Lens' ModelDashboardMonitoringSchedule (Maybe MonitoringType) Source #

The monitor type of a model monitor.

ModelDataQuality

modelDataQuality_constraints :: Lens' ModelDataQuality (Maybe MetricsSource) Source #

Data quality constraints for a model.

modelDataQuality_statistics :: Lens' ModelDataQuality (Maybe MetricsSource) Source #

Data quality statistics for a model.

ModelDeployConfig

modelDeployConfig_autoGenerateEndpointName :: Lens' ModelDeployConfig (Maybe Bool) Source #

Set to True to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False otherwise. The default value is False.

If you set AutoGenerateEndpointName to True, do not specify the EndpointName; otherwise a 400 error is thrown.

modelDeployConfig_endpointName :: Lens' ModelDeployConfig (Maybe Text) Source #

Specifies the endpoint name to use for a one-click Autopilot model deployment if the endpoint name is not generated automatically.

Specify the EndpointName if and only if you set AutoGenerateEndpointName to False; otherwise a 400 error is thrown.

ModelDeployResult

modelDeployResult_endpointName :: Lens' ModelDeployResult (Maybe Text) Source #

The name of the endpoint to which the model has been deployed.

If model deployment fails, this field is omitted from the response.

ModelDigests

modelDigests_artifactDigest :: Lens' ModelDigests (Maybe Text) Source #

Provides a hash value that uniquely identifies the stored model artifacts.

ModelExplainabilityAppSpecification

modelExplainabilityAppSpecification_environment :: Lens' ModelExplainabilityAppSpecification (Maybe (HashMap Text Text)) Source #

Sets the environment variables in the Docker container.

modelExplainabilityAppSpecification_imageUri :: Lens' ModelExplainabilityAppSpecification Text Source #

The container image to be run by the model explainability job.

modelExplainabilityAppSpecification_configUri :: Lens' ModelExplainabilityAppSpecification Text Source #

JSON formatted S3 file that defines explainability parameters. For more information on this JSON configuration file, see Configure model explainability parameters.

ModelExplainabilityBaselineConfig

modelExplainabilityBaselineConfig_baseliningJobName :: Lens' ModelExplainabilityBaselineConfig (Maybe Text) Source #

The name of the baseline model explainability job.

modelExplainabilityBaselineConfig_constraintsResource :: Lens' ModelExplainabilityBaselineConfig (Maybe MonitoringConstraintsResource) Source #

Undocumented member.

ModelExplainabilityJobInput

modelExplainabilityJobInput_batchTransformInput :: Lens' ModelExplainabilityJobInput (Maybe BatchTransformInput) Source #

Input object for the batch transform job.

modelExplainabilityJobInput_endpointInput :: Lens' ModelExplainabilityJobInput (Maybe EndpointInput) Source #

Undocumented member.

ModelInfrastructureConfig

modelInfrastructureConfig_infrastructureType :: Lens' ModelInfrastructureConfig ModelInfrastructureType Source #

The inference option to which to deploy your model. Possible values are the following:

  • RealTime: Deploy to real-time inference.

modelInfrastructureConfig_realTimeInferenceConfig :: Lens' ModelInfrastructureConfig RealTimeInferenceConfig Source #

The infrastructure configuration for deploying the model to real-time inference.

ModelInput

modelInput_dataInputConfig :: Lens' ModelInput Text Source #

The input configuration object for the model.

ModelLatencyThreshold

modelLatencyThreshold_percentile :: Lens' ModelLatencyThreshold (Maybe Text) Source #

The model latency percentile threshold.

modelLatencyThreshold_valueInMilliseconds :: Lens' ModelLatencyThreshold (Maybe Int) Source #

The model latency percentile value in milliseconds.

ModelMetadataFilter

modelMetadataFilter_name :: Lens' ModelMetadataFilter ModelMetadataFilterType Source #

The name of the of the model to filter by.

modelMetadataFilter_value :: Lens' ModelMetadataFilter Text Source #

The value to filter the model metadata.

ModelMetadataSearchExpression

modelMetadataSearchExpression_filters :: Lens' ModelMetadataSearchExpression (Maybe (NonEmpty ModelMetadataFilter)) Source #

A list of filter objects.

ModelMetadataSummary

modelMetadataSummary_domain :: Lens' ModelMetadataSummary Text Source #

The machine learning domain of the model.

modelMetadataSummary_framework :: Lens' ModelMetadataSummary Text Source #

The machine learning framework of the model.

modelMetadataSummary_task :: Lens' ModelMetadataSummary Text Source #

The machine learning task of the model.

modelMetadataSummary_model :: Lens' ModelMetadataSummary Text Source #

The name of the model.

modelMetadataSummary_frameworkVersion :: Lens' ModelMetadataSummary Text Source #

The framework version of the model.

ModelMetrics

modelMetrics_bias :: Lens' ModelMetrics (Maybe Bias) Source #

Metrics that measure bais in a model.

modelMetrics_explainability :: Lens' ModelMetrics (Maybe Explainability) Source #

Metrics that help explain a model.

modelMetrics_modelDataQuality :: Lens' ModelMetrics (Maybe ModelDataQuality) Source #

Metrics that measure the quality of the input data for a model.

modelMetrics_modelQuality :: Lens' ModelMetrics (Maybe ModelQuality) Source #

Metrics that measure the quality of a model.

ModelPackage

modelPackage_additionalInferenceSpecifications :: Lens' ModelPackage (Maybe (NonEmpty AdditionalInferenceSpecificationDefinition)) Source #

An array of additional Inference Specification objects.

modelPackage_approvalDescription :: Lens' ModelPackage (Maybe Text) Source #

A description provided when the model approval is set.

modelPackage_certifyForMarketplace :: Lens' ModelPackage (Maybe Bool) Source #

Whether the model package is to be certified to be listed on Amazon Web Services Marketplace. For information about listing model packages on Amazon Web Services Marketplace, see List Your Algorithm or Model Package on Amazon Web Services Marketplace.

modelPackage_createdBy :: Lens' ModelPackage (Maybe UserContext) Source #

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

modelPackage_creationTime :: Lens' ModelPackage (Maybe UTCTime) Source #

The time that the model package was created.

modelPackage_customerMetadataProperties :: Lens' ModelPackage (Maybe (HashMap Text Text)) Source #

The metadata properties for the model package.

modelPackage_domain :: Lens' ModelPackage (Maybe Text) Source #

The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.

modelPackage_driftCheckBaselines :: Lens' ModelPackage (Maybe DriftCheckBaselines) Source #

Represents the drift check baselines that can be used when the model monitor is set using the model package.

modelPackage_inferenceSpecification :: Lens' ModelPackage (Maybe InferenceSpecification) Source #

Defines how to perform inference generation after a training job is run.

modelPackage_lastModifiedBy :: Lens' ModelPackage (Maybe UserContext) Source #

Information about the user who created or modified an experiment, trial, trial component, lineage group, or project.

modelPackage_lastModifiedTime :: Lens' ModelPackage (Maybe UTCTime) Source #

The last time the model package was modified.

modelPackage_metadataProperties :: Lens' ModelPackage (Maybe MetadataProperties) Source #

Metadata properties of the tracking entity, trial, or trial component.

modelPackage_modelApprovalStatus :: Lens' ModelPackage (Maybe ModelApprovalStatus) Source #

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.

modelPackage_modelMetrics :: Lens' ModelPackage (Maybe ModelMetrics) Source #

Metrics for the model.

modelPackage_modelPackageArn :: Lens' ModelPackage (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model package.

modelPackage_modelPackageDescription :: Lens' ModelPackage (Maybe Text) Source #

The description of the model package.

modelPackage_modelPackageGroupName :: Lens' ModelPackage (Maybe Text) Source #

The model group to which the model belongs.

modelPackage_modelPackageName :: Lens' ModelPackage (Maybe Text) Source #

The name of the model.

modelPackage_modelPackageStatus :: Lens' ModelPackage (Maybe ModelPackageStatus) Source #

The status of the model package. This can be one of the following values.

  • PENDING - The model package is pending being created.
  • IN_PROGRESS - The model package is in the process of being created.
  • COMPLETED - The model package was successfully created.
  • FAILED - The model package failed.
  • DELETING - The model package is in the process of being deleted.

modelPackage_modelPackageStatusDetails :: Lens' ModelPackage (Maybe ModelPackageStatusDetails) Source #

Specifies the validation and image scan statuses of the model package.

modelPackage_modelPackageVersion :: Lens' ModelPackage (Maybe Natural) Source #

The version number of a versioned model.

modelPackage_samplePayloadUrl :: Lens' ModelPackage (Maybe Text) Source #

The Amazon Simple Storage Service path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

modelPackage_sourceAlgorithmSpecification :: Lens' ModelPackage (Maybe SourceAlgorithmSpecification) Source #

A list of algorithms that were used to create a model package.

modelPackage_tags :: Lens' ModelPackage (Maybe [Tag]) Source #

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

modelPackage_task :: Lens' ModelPackage (Maybe Text) Source #

The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.

modelPackage_validationSpecification :: Lens' ModelPackage (Maybe ModelPackageValidationSpecification) Source #

Specifies batch transform jobs that SageMaker runs to validate your model package.

ModelPackageContainerDefinition

modelPackageContainerDefinition_containerHostname :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

The DNS host name for the Docker container.

modelPackageContainerDefinition_environment :: Lens' ModelPackageContainerDefinition (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

modelPackageContainerDefinition_framework :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

The machine learning framework of the model package container image.

modelPackageContainerDefinition_frameworkVersion :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

The framework version of the Model Package Container Image.

modelPackageContainerDefinition_imageDigest :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

An MD5 hash of the training algorithm that identifies the Docker image used for training.

modelPackageContainerDefinition_modelDataUrl :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the model package.

modelPackageContainerDefinition_modelInput :: Lens' ModelPackageContainerDefinition (Maybe ModelInput) Source #

A structure with Model Input details.

modelPackageContainerDefinition_nearestModelName :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

The name of a pre-trained machine learning benchmarked by Amazon SageMaker Inference Recommender model that matches your model. You can find a list of benchmarked models by calling ListModelMetadata.

modelPackageContainerDefinition_productId :: Lens' ModelPackageContainerDefinition (Maybe Text) Source #

The Amazon Web Services Marketplace product ID of the model package.

modelPackageContainerDefinition_image :: Lens' ModelPackageContainerDefinition Text Source #

The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

If you are using your own custom algorithm instead of an algorithm provided by SageMaker, the inference code must meet SageMaker requirements. SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

ModelPackageGroup

modelPackageGroup_createdBy :: Lens' ModelPackageGroup (Maybe UserContext) Source #

Undocumented member.

modelPackageGroup_creationTime :: Lens' ModelPackageGroup (Maybe UTCTime) Source #

The time that the model group was created.

modelPackageGroup_modelPackageGroupArn :: Lens' ModelPackageGroup (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model group.

modelPackageGroup_modelPackageGroupDescription :: Lens' ModelPackageGroup (Maybe Text) Source #

The description for the model group.

modelPackageGroup_modelPackageGroupName :: Lens' ModelPackageGroup (Maybe Text) Source #

The name of the model group.

modelPackageGroup_modelPackageGroupStatus :: Lens' ModelPackageGroup (Maybe ModelPackageGroupStatus) Source #

The status of the model group. This can be one of the following values.

  • PENDING - The model group is pending being created.
  • IN_PROGRESS - The model group is in the process of being created.
  • COMPLETED - The model group was successfully created.
  • FAILED - The model group failed.
  • DELETING - The model group is in the process of being deleted.
  • DELETE_FAILED - SageMaker failed to delete the model group.

modelPackageGroup_tags :: Lens' ModelPackageGroup (Maybe [Tag]) Source #

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

ModelPackageGroupSummary

modelPackageGroupSummary_modelPackageGroupDescription :: Lens' ModelPackageGroupSummary (Maybe Text) Source #

A description of the model group.

modelPackageGroupSummary_modelPackageGroupName :: Lens' ModelPackageGroupSummary Text Source #

The name of the model group.

modelPackageGroupSummary_modelPackageGroupArn :: Lens' ModelPackageGroupSummary Text Source #

The Amazon Resource Name (ARN) of the model group.

modelPackageGroupSummary_creationTime :: Lens' ModelPackageGroupSummary UTCTime Source #

The time that the model group was created.

modelPackageGroupSummary_modelPackageGroupStatus :: Lens' ModelPackageGroupSummary ModelPackageGroupStatus Source #

The status of the model group.

ModelPackageStatusDetails

modelPackageStatusDetails_imageScanStatuses :: Lens' ModelPackageStatusDetails (Maybe [ModelPackageStatusItem]) Source #

The status of the scan of the Docker image container for the model package.

modelPackageStatusDetails_validationStatuses :: Lens' ModelPackageStatusDetails [ModelPackageStatusItem] Source #

The validation status of the model package.

ModelPackageStatusItem

modelPackageStatusItem_failureReason :: Lens' ModelPackageStatusItem (Maybe Text) Source #

if the overall status is Failed, the reason for the failure.

modelPackageStatusItem_name :: Lens' ModelPackageStatusItem Text Source #

The name of the model package for which the overall status is being reported.

modelPackageStatusItem_status :: Lens' ModelPackageStatusItem DetailedModelPackageStatus Source #

The current status.

ModelPackageSummary

modelPackageSummary_modelApprovalStatus :: Lens' ModelPackageSummary (Maybe ModelApprovalStatus) Source #

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.

modelPackageSummary_modelPackageDescription :: Lens' ModelPackageSummary (Maybe Text) Source #

A brief description of the model package.

modelPackageSummary_modelPackageGroupName :: Lens' ModelPackageSummary (Maybe Text) Source #

If the model package is a versioned model, the model group that the versioned model belongs to.

modelPackageSummary_modelPackageVersion :: Lens' ModelPackageSummary (Maybe Natural) Source #

If the model package is a versioned model, the version of the model.

modelPackageSummary_modelPackageName :: Lens' ModelPackageSummary Text Source #

The name of the model package.

modelPackageSummary_modelPackageArn :: Lens' ModelPackageSummary Text Source #

The Amazon Resource Name (ARN) of the model package.

modelPackageSummary_creationTime :: Lens' ModelPackageSummary UTCTime Source #

A timestamp that shows when the model package was created.

modelPackageSummary_modelPackageStatus :: Lens' ModelPackageSummary ModelPackageStatus Source #

The overall status of the model package.

ModelPackageValidationProfile

modelPackageValidationProfile_profileName :: Lens' ModelPackageValidationProfile Text Source #

The name of the profile for the model package.

modelPackageValidationProfile_transformJobDefinition :: Lens' ModelPackageValidationProfile TransformJobDefinition Source #

The TransformJobDefinition object that describes the transform job used for the validation of the model package.

ModelPackageValidationSpecification

modelPackageValidationSpecification_validationRole :: Lens' ModelPackageValidationSpecification Text Source #

The IAM roles to be used for the validation of the model package.

modelPackageValidationSpecification_validationProfiles :: Lens' ModelPackageValidationSpecification (NonEmpty ModelPackageValidationProfile) Source #

An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that SageMaker runs to validate your model package.

ModelQuality

modelQuality_constraints :: Lens' ModelQuality (Maybe MetricsSource) Source #

Model quality constraints.

modelQuality_statistics :: Lens' ModelQuality (Maybe MetricsSource) Source #

Model quality statistics.

ModelQualityAppSpecification

modelQualityAppSpecification_containerArguments :: Lens' ModelQualityAppSpecification (Maybe (NonEmpty Text)) Source #

An array of arguments for the container used to run the monitoring job.

modelQualityAppSpecification_containerEntrypoint :: Lens' ModelQualityAppSpecification (Maybe (NonEmpty Text)) Source #

Specifies the entrypoint for a container that the monitoring job runs.

modelQualityAppSpecification_environment :: Lens' ModelQualityAppSpecification (Maybe (HashMap Text Text)) Source #

Sets the environment variables in the container that the monitoring job runs.

modelQualityAppSpecification_postAnalyticsProcessorSourceUri :: Lens' ModelQualityAppSpecification (Maybe Text) Source #

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

modelQualityAppSpecification_problemType :: Lens' ModelQualityAppSpecification (Maybe MonitoringProblemType) Source #

The machine learning problem type of the model that the monitoring job monitors.

modelQualityAppSpecification_recordPreprocessorSourceUri :: Lens' ModelQualityAppSpecification (Maybe Text) Source #

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

modelQualityAppSpecification_imageUri :: Lens' ModelQualityAppSpecification Text Source #

The address of the container image that the monitoring job runs.

ModelQualityBaselineConfig

modelQualityBaselineConfig_baseliningJobName :: Lens' ModelQualityBaselineConfig (Maybe Text) Source #

The name of the job that performs baselining for the monitoring job.

modelQualityBaselineConfig_constraintsResource :: Lens' ModelQualityBaselineConfig (Maybe MonitoringConstraintsResource) Source #

Undocumented member.

ModelQualityJobInput

modelQualityJobInput_batchTransformInput :: Lens' ModelQualityJobInput (Maybe BatchTransformInput) Source #

Input object for the batch transform job.

modelQualityJobInput_endpointInput :: Lens' ModelQualityJobInput (Maybe EndpointInput) Source #

Undocumented member.

modelQualityJobInput_groundTruthS3Input :: Lens' ModelQualityJobInput MonitoringGroundTruthS3Input Source #

The ground truth label provided for the model.

ModelStepMetadata

modelStepMetadata_arn :: Lens' ModelStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created model.

ModelSummary

modelSummary_modelName :: Lens' ModelSummary Text Source #

The name of the model that you want a summary for.

modelSummary_modelArn :: Lens' ModelSummary Text Source #

The Amazon Resource Name (ARN) of the model.

modelSummary_creationTime :: Lens' ModelSummary UTCTime Source #

A timestamp that indicates when the model was created.

ModelVariantConfig

modelVariantConfig_modelName :: Lens' ModelVariantConfig Text Source #

The name of the Amazon SageMaker Model entity.

modelVariantConfig_variantName :: Lens' ModelVariantConfig Text Source #

The name of the variant.

modelVariantConfig_infrastructureConfig :: Lens' ModelVariantConfig ModelInfrastructureConfig Source #

The configuration for the infrastructure that the model will be deployed to.

ModelVariantConfigSummary

modelVariantConfigSummary_modelName :: Lens' ModelVariantConfigSummary Text Source #

The name of the Amazon SageMaker Model entity.

modelVariantConfigSummary_variantName :: Lens' ModelVariantConfigSummary Text Source #

The name of the variant.

modelVariantConfigSummary_infrastructureConfig :: Lens' ModelVariantConfigSummary ModelInfrastructureConfig Source #

The configuration of the infrastructure that the model has been deployed to.

modelVariantConfigSummary_status :: Lens' ModelVariantConfigSummary ModelVariantStatus Source #

The status of deployment for the model variant on the hosted inference endpoint.

  • Creating - Amazon SageMaker is preparing the model variant on the hosted inference endpoint.
  • InService - The model variant is running on the hosted inference endpoint.
  • Updating - Amazon SageMaker is updating the model variant on the hosted inference endpoint.
  • Deleting - Amazon SageMaker is deleting the model variant on the hosted inference endpoint.
  • Deleted - The model variant has been deleted on the hosted inference endpoint. This can only happen after stopping the experiment.

MonitoringAlertActions

monitoringAlertActions_modelDashboardIndicator :: Lens' MonitoringAlertActions (Maybe ModelDashboardIndicatorAction) Source #

An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

MonitoringAlertHistorySummary

monitoringAlertHistorySummary_monitoringScheduleName :: Lens' MonitoringAlertHistorySummary Text Source #

The name of a monitoring schedule.

monitoringAlertHistorySummary_monitoringAlertName :: Lens' MonitoringAlertHistorySummary Text Source #

The name of a monitoring alert.

monitoringAlertHistorySummary_creationTime :: Lens' MonitoringAlertHistorySummary UTCTime Source #

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.

monitoringAlertHistorySummary_alertStatus :: Lens' MonitoringAlertHistorySummary MonitoringAlertStatus Source #

The current alert status of an alert.

MonitoringAlertSummary

monitoringAlertSummary_monitoringAlertName :: Lens' MonitoringAlertSummary Text Source #

The name of a monitoring alert.

monitoringAlertSummary_creationTime :: Lens' MonitoringAlertSummary UTCTime Source #

A timestamp that indicates when a monitor alert was created.

monitoringAlertSummary_lastModifiedTime :: Lens' MonitoringAlertSummary UTCTime Source #

A timestamp that indicates when a monitor alert was last updated.

monitoringAlertSummary_alertStatus :: Lens' MonitoringAlertSummary MonitoringAlertStatus Source #

The current status of an alert.

monitoringAlertSummary_datapointsToAlert :: Lens' MonitoringAlertSummary Natural Source #

Within EvaluationPeriod, how many execution failures will raise an alert.

monitoringAlertSummary_evaluationPeriod :: Lens' MonitoringAlertSummary Natural Source #

The number of most recent monitoring executions to consider when evaluating alert status.

monitoringAlertSummary_actions :: Lens' MonitoringAlertSummary MonitoringAlertActions Source #

A list of alert actions taken in response to an alert going into InAlert status.

MonitoringAppSpecification

monitoringAppSpecification_containerArguments :: Lens' MonitoringAppSpecification (Maybe (NonEmpty Text)) Source #

An array of arguments for the container used to run the monitoring job.

monitoringAppSpecification_containerEntrypoint :: Lens' MonitoringAppSpecification (Maybe (NonEmpty Text)) Source #

Specifies the entrypoint for a container used to run the monitoring job.

monitoringAppSpecification_postAnalyticsProcessorSourceUri :: Lens' MonitoringAppSpecification (Maybe Text) Source #

An Amazon S3 URI to a script that is called after analysis has been performed. Applicable only for the built-in (first party) containers.

monitoringAppSpecification_recordPreprocessorSourceUri :: Lens' MonitoringAppSpecification (Maybe Text) Source #

An Amazon S3 URI to a script that is called per row prior to running analysis. It can base64 decode the payload and convert it into a flatted json so that the built-in container can use the converted data. Applicable only for the built-in (first party) containers.

monitoringAppSpecification_imageUri :: Lens' MonitoringAppSpecification Text Source #

The container image to be run by the monitoring job.

MonitoringBaselineConfig

monitoringBaselineConfig_baseliningJobName :: Lens' MonitoringBaselineConfig (Maybe Text) Source #

The name of the job that performs baselining for the monitoring job.

monitoringBaselineConfig_constraintsResource :: Lens' MonitoringBaselineConfig (Maybe MonitoringConstraintsResource) Source #

The baseline constraint file in Amazon S3 that the current monitoring job should validated against.

monitoringBaselineConfig_statisticsResource :: Lens' MonitoringBaselineConfig (Maybe MonitoringStatisticsResource) Source #

The baseline statistics file in Amazon S3 that the current monitoring job should be validated against.

MonitoringClusterConfig

monitoringClusterConfig_volumeKmsKeyId :: Lens' MonitoringClusterConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.

monitoringClusterConfig_instanceCount :: Lens' MonitoringClusterConfig Natural Source #

The number of ML compute instances to use in the model monitoring job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

monitoringClusterConfig_instanceType :: Lens' MonitoringClusterConfig ProcessingInstanceType Source #

The ML compute instance type for the processing job.

monitoringClusterConfig_volumeSizeInGB :: Lens' MonitoringClusterConfig Natural Source #

The size of the ML storage volume, in gigabytes, that you want to provision. You must specify sufficient ML storage for your scenario.

MonitoringConstraintsResource

monitoringConstraintsResource_s3Uri :: Lens' MonitoringConstraintsResource (Maybe Text) Source #

The Amazon S3 URI for the constraints resource.

MonitoringCsvDatasetFormat

monitoringCsvDatasetFormat_header :: Lens' MonitoringCsvDatasetFormat (Maybe Bool) Source #

Indicates if the CSV data has a header.

MonitoringDatasetFormat

monitoringDatasetFormat_csv :: Lens' MonitoringDatasetFormat (Maybe MonitoringCsvDatasetFormat) Source #

The CSV dataset used in the monitoring job.

monitoringDatasetFormat_json :: Lens' MonitoringDatasetFormat (Maybe MonitoringJsonDatasetFormat) Source #

The JSON dataset used in the monitoring job

monitoringDatasetFormat_parquet :: Lens' MonitoringDatasetFormat (Maybe MonitoringParquetDatasetFormat) Source #

The Parquet dataset used in the monitoring job

MonitoringExecutionSummary

monitoringExecutionSummary_endpointName :: Lens' MonitoringExecutionSummary (Maybe Text) Source #

The name of the endpoint used to run the monitoring job.

monitoringExecutionSummary_failureReason :: Lens' MonitoringExecutionSummary (Maybe Text) Source #

Contains the reason a monitoring job failed, if it failed.

monitoringExecutionSummary_monitoringJobDefinitionName :: Lens' MonitoringExecutionSummary (Maybe Text) Source #

The name of the monitoring job.

monitoringExecutionSummary_monitoringType :: Lens' MonitoringExecutionSummary (Maybe MonitoringType) Source #

The type of the monitoring job.

monitoringExecutionSummary_processingJobArn :: Lens' MonitoringExecutionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the monitoring job.

monitoringExecutionSummary_monitoringScheduleName :: Lens' MonitoringExecutionSummary Text Source #

The name of the monitoring schedule.

monitoringExecutionSummary_scheduledTime :: Lens' MonitoringExecutionSummary UTCTime Source #

The time the monitoring job was scheduled.

monitoringExecutionSummary_creationTime :: Lens' MonitoringExecutionSummary UTCTime Source #

The time at which the monitoring job was created.

monitoringExecutionSummary_lastModifiedTime :: Lens' MonitoringExecutionSummary UTCTime Source #

A timestamp that indicates the last time the monitoring job was modified.

monitoringExecutionSummary_monitoringExecutionStatus :: Lens' MonitoringExecutionSummary ExecutionStatus Source #

The status of the monitoring job.

MonitoringGroundTruthS3Input

monitoringGroundTruthS3Input_s3Uri :: Lens' MonitoringGroundTruthS3Input (Maybe Text) Source #

The address of the Amazon S3 location of the ground truth labels.

MonitoringInput

monitoringInput_batchTransformInput :: Lens' MonitoringInput (Maybe BatchTransformInput) Source #

Input object for the batch transform job.

monitoringInput_endpointInput :: Lens' MonitoringInput (Maybe EndpointInput) Source #

The endpoint for a monitoring job.

MonitoringJobDefinition

monitoringJobDefinition_baselineConfig :: Lens' MonitoringJobDefinition (Maybe MonitoringBaselineConfig) Source #

Baseline configuration used to validate that the data conforms to the specified constraints and statistics

monitoringJobDefinition_environment :: Lens' MonitoringJobDefinition (Maybe (HashMap Text Text)) Source #

Sets the environment variables in the Docker container.

monitoringJobDefinition_networkConfig :: Lens' MonitoringJobDefinition (Maybe NetworkConfig) Source #

Specifies networking options for an monitoring job.

monitoringJobDefinition_stoppingCondition :: Lens' MonitoringJobDefinition (Maybe MonitoringStoppingCondition) Source #

Specifies a time limit for how long the monitoring job is allowed to run.

monitoringJobDefinition_monitoringInputs :: Lens' MonitoringJobDefinition (NonEmpty MonitoringInput) Source #

The array of inputs for the monitoring job. Currently we support monitoring an Amazon SageMaker Endpoint.

monitoringJobDefinition_monitoringOutputConfig :: Lens' MonitoringJobDefinition MonitoringOutputConfig Source #

The array of outputs from the monitoring job to be uploaded to Amazon Simple Storage Service (Amazon S3).

monitoringJobDefinition_monitoringResources :: Lens' MonitoringJobDefinition MonitoringResources Source #

Identifies the resources, ML compute instances, and ML storage volumes to deploy for a monitoring job. In distributed processing, you specify more than one instance.

monitoringJobDefinition_monitoringAppSpecification :: Lens' MonitoringJobDefinition MonitoringAppSpecification Source #

Configures the monitoring job to run a specified Docker container image.

monitoringJobDefinition_roleArn :: Lens' MonitoringJobDefinition Text Source #

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

MonitoringJobDefinitionSummary

monitoringJobDefinitionSummary_monitoringJobDefinitionName :: Lens' MonitoringJobDefinitionSummary Text Source #

The name of the monitoring job.

monitoringJobDefinitionSummary_monitoringJobDefinitionArn :: Lens' MonitoringJobDefinitionSummary Text Source #

The Amazon Resource Name (ARN) of the monitoring job.

monitoringJobDefinitionSummary_creationTime :: Lens' MonitoringJobDefinitionSummary UTCTime Source #

The time that the monitoring job was created.

monitoringJobDefinitionSummary_endpointName :: Lens' MonitoringJobDefinitionSummary Text Source #

The name of the endpoint that the job monitors.

MonitoringJsonDatasetFormat

monitoringJsonDatasetFormat_line :: Lens' MonitoringJsonDatasetFormat (Maybe Bool) Source #

Indicates if the file should be read as a json object per line.

MonitoringNetworkConfig

monitoringNetworkConfig_enableInterContainerTrafficEncryption :: Lens' MonitoringNetworkConfig (Maybe Bool) Source #

Whether to encrypt all communications between the instances used for the monitoring jobs. Choose True to encrypt communications. Encryption provides greater security for distributed jobs, but the processing might take longer.

monitoringNetworkConfig_enableNetworkIsolation :: Lens' MonitoringNetworkConfig (Maybe Bool) Source #

Whether to allow inbound and outbound network calls to and from the containers used for the monitoring job.

monitoringNetworkConfig_vpcConfig :: Lens' MonitoringNetworkConfig (Maybe VpcConfig) Source #

Undocumented member.

MonitoringOutput

monitoringOutput_s3Output :: Lens' MonitoringOutput MonitoringS3Output Source #

The Amazon S3 storage location where the results of a monitoring job are saved.

MonitoringOutputConfig

monitoringOutputConfig_kmsKeyId :: Lens' MonitoringOutputConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.

monitoringOutputConfig_monitoringOutputs :: Lens' MonitoringOutputConfig (NonEmpty MonitoringOutput) Source #

Monitoring outputs for monitoring jobs. This is where the output of the periodic monitoring jobs is uploaded.

MonitoringParquetDatasetFormat

MonitoringResources

monitoringResources_clusterConfig :: Lens' MonitoringResources MonitoringClusterConfig Source #

The configuration for the cluster resources used to run the processing job.

MonitoringS3Output

monitoringS3Output_s3UploadMode :: Lens' MonitoringS3Output (Maybe ProcessingS3UploadMode) Source #

Whether to upload the results of the monitoring job continuously or after the job completes.

monitoringS3Output_s3Uri :: Lens' MonitoringS3Output Text Source #

A URI that identifies the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job.

monitoringS3Output_localPath :: Lens' MonitoringS3Output Text Source #

The local path to the Amazon S3 storage location where Amazon SageMaker saves the results of a monitoring job. LocalPath is an absolute path for the output data.

MonitoringSchedule

monitoringSchedule_creationTime :: Lens' MonitoringSchedule (Maybe UTCTime) Source #

The time that the monitoring schedule was created.

monitoringSchedule_endpointName :: Lens' MonitoringSchedule (Maybe Text) Source #

The endpoint that hosts the model being monitored.

monitoringSchedule_failureReason :: Lens' MonitoringSchedule (Maybe Text) Source #

If the monitoring schedule failed, the reason it failed.

monitoringSchedule_lastModifiedTime :: Lens' MonitoringSchedule (Maybe UTCTime) Source #

The last time the monitoring schedule was changed.

monitoringSchedule_lastMonitoringExecutionSummary :: Lens' MonitoringSchedule (Maybe MonitoringExecutionSummary) Source #

Undocumented member.

monitoringSchedule_monitoringScheduleArn :: Lens' MonitoringSchedule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the monitoring schedule.

monitoringSchedule_monitoringScheduleConfig :: Lens' MonitoringSchedule (Maybe MonitoringScheduleConfig) Source #

Undocumented member.

monitoringSchedule_monitoringScheduleName :: Lens' MonitoringSchedule (Maybe Text) Source #

The name of the monitoring schedule.

monitoringSchedule_monitoringScheduleStatus :: Lens' MonitoringSchedule (Maybe ScheduleStatus) Source #

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.
  • FAILED - The schedule failed.
  • SCHEDULED - The schedule was successfully created.
  • STOPPED - The schedule was stopped.

monitoringSchedule_monitoringType :: Lens' MonitoringSchedule (Maybe MonitoringType) Source #

The type of the monitoring job definition to schedule.

monitoringSchedule_tags :: Lens' MonitoringSchedule (Maybe [Tag]) Source #

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

MonitoringScheduleConfig

monitoringScheduleConfig_monitoringJobDefinition :: Lens' MonitoringScheduleConfig (Maybe MonitoringJobDefinition) Source #

Defines the monitoring job.

monitoringScheduleConfig_monitoringJobDefinitionName :: Lens' MonitoringScheduleConfig (Maybe Text) Source #

The name of the monitoring job definition to schedule.

monitoringScheduleConfig_monitoringType :: Lens' MonitoringScheduleConfig (Maybe MonitoringType) Source #

The type of the monitoring job definition to schedule.

monitoringScheduleConfig_scheduleConfig :: Lens' MonitoringScheduleConfig (Maybe ScheduleConfig) Source #

Configures the monitoring schedule.

MonitoringScheduleSummary

monitoringScheduleSummary_endpointName :: Lens' MonitoringScheduleSummary (Maybe Text) Source #

The name of the endpoint using the monitoring schedule.

monitoringScheduleSummary_monitoringJobDefinitionName :: Lens' MonitoringScheduleSummary (Maybe Text) Source #

The name of the monitoring job definition that the schedule is for.

monitoringScheduleSummary_monitoringType :: Lens' MonitoringScheduleSummary (Maybe MonitoringType) Source #

The type of the monitoring job definition that the schedule is for.

monitoringScheduleSummary_monitoringScheduleName :: Lens' MonitoringScheduleSummary Text Source #

The name of the monitoring schedule.

monitoringScheduleSummary_monitoringScheduleArn :: Lens' MonitoringScheduleSummary Text Source #

The Amazon Resource Name (ARN) of the monitoring schedule.

monitoringScheduleSummary_creationTime :: Lens' MonitoringScheduleSummary UTCTime Source #

The creation time of the monitoring schedule.

monitoringScheduleSummary_lastModifiedTime :: Lens' MonitoringScheduleSummary UTCTime Source #

The last time the monitoring schedule was modified.

monitoringScheduleSummary_monitoringScheduleStatus :: Lens' MonitoringScheduleSummary ScheduleStatus Source #

The status of the monitoring schedule.

MonitoringStatisticsResource

monitoringStatisticsResource_s3Uri :: Lens' MonitoringStatisticsResource (Maybe Text) Source #

The Amazon S3 URI for the statistics resource.

MonitoringStoppingCondition

monitoringStoppingCondition_maxRuntimeInSeconds :: Lens' MonitoringStoppingCondition Natural Source #

The maximum runtime allowed in seconds.

The MaxRuntimeInSeconds cannot exceed the frequency of the job. For data quality and model explainability, this can be up to 3600 seconds for an hourly schedule. For model bias and model quality hourly schedules, this can be up to 1800 seconds.

MultiModelConfig

multiModelConfig_modelCacheSetting :: Lens' MultiModelConfig (Maybe ModelCacheSetting) Source #

Whether to cache models for a multi-model endpoint. By default, multi-model endpoints cache models so that a model does not have to be loaded into memory each time it is invoked. Some use cases do not benefit from model caching. For example, if an endpoint hosts a large number of models that are each invoked infrequently, the endpoint might perform better if you disable model caching. To disable model caching, set the value of this parameter to Disabled.

NeoVpcConfig

neoVpcConfig_securityGroupIds :: Lens' NeoVpcConfig (NonEmpty Text) Source #

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

neoVpcConfig_subnets :: Lens' NeoVpcConfig (NonEmpty Text) Source #

The ID of the subnets in the VPC that you want to connect the compilation job to for accessing the model in Amazon S3.

NestedFilters

nestedFilters_nestedPropertyName :: Lens' NestedFilters Text Source #

The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig.

nestedFilters_filters :: Lens' NestedFilters (NonEmpty Filter) Source #

A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

NetworkConfig

networkConfig_enableInterContainerTrafficEncryption :: Lens' NetworkConfig (Maybe Bool) Source #

Whether to encrypt all communications between distributed processing jobs. Choose True to encrypt communications. Encryption provides greater security for distributed processing jobs, but the processing might take longer.

networkConfig_enableNetworkIsolation :: Lens' NetworkConfig (Maybe Bool) Source #

Whether to allow inbound and outbound network calls to and from the containers used for the processing job.

networkConfig_vpcConfig :: Lens' NetworkConfig (Maybe VpcConfig) Source #

Undocumented member.

NotebookInstanceLifecycleConfigSummary

notebookInstanceLifecycleConfigSummary_creationTime :: Lens' NotebookInstanceLifecycleConfigSummary (Maybe UTCTime) Source #

A timestamp that tells when the lifecycle configuration was created.

notebookInstanceLifecycleConfigSummary_lastModifiedTime :: Lens' NotebookInstanceLifecycleConfigSummary (Maybe UTCTime) Source #

A timestamp that tells when the lifecycle configuration was last modified.

notebookInstanceLifecycleConfigSummary_notebookInstanceLifecycleConfigName :: Lens' NotebookInstanceLifecycleConfigSummary Text Source #

The name of the lifecycle configuration.

notebookInstanceLifecycleConfigSummary_notebookInstanceLifecycleConfigArn :: Lens' NotebookInstanceLifecycleConfigSummary Text Source #

The Amazon Resource Name (ARN) of the lifecycle configuration.

NotebookInstanceLifecycleHook

notebookInstanceLifecycleHook_content :: Lens' NotebookInstanceLifecycleHook (Maybe Text) Source #

A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

NotebookInstanceSummary

notebookInstanceSummary_additionalCodeRepositories :: Lens' NotebookInstanceSummary (Maybe [Text]) Source #

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 Notebook Instances.

notebookInstanceSummary_creationTime :: Lens' NotebookInstanceSummary (Maybe UTCTime) Source #

A timestamp that shows when the notebook instance was created.

notebookInstanceSummary_defaultCodeRepository :: Lens' NotebookInstanceSummary (Maybe Text) Source #

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 Notebook Instances.

notebookInstanceSummary_instanceType :: Lens' NotebookInstanceSummary (Maybe InstanceType) Source #

The type of ML compute instance that the notebook instance is running on.

notebookInstanceSummary_lastModifiedTime :: Lens' NotebookInstanceSummary (Maybe UTCTime) Source #

A timestamp that shows when the notebook instance was last modified.

notebookInstanceSummary_notebookInstanceLifecycleConfigName :: Lens' NotebookInstanceSummary (Maybe Text) Source #

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.

notebookInstanceSummary_notebookInstanceStatus :: Lens' NotebookInstanceSummary (Maybe NotebookInstanceStatus) Source #

The status of the notebook instance.

notebookInstanceSummary_url :: Lens' NotebookInstanceSummary (Maybe Text) Source #

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

notebookInstanceSummary_notebookInstanceName :: Lens' NotebookInstanceSummary Text Source #

The name of the notebook instance that you want a summary for.

notebookInstanceSummary_notebookInstanceArn :: Lens' NotebookInstanceSummary Text Source #

The Amazon Resource Name (ARN) of the notebook instance.

NotificationConfiguration

notificationConfiguration_notificationTopicArn :: Lens' NotificationConfiguration (Maybe Text) Source #

The ARN for the Amazon SNS topic to which notifications should be published.

ObjectiveStatusCounters

objectiveStatusCounters_failed :: Lens' ObjectiveStatusCounters (Maybe Natural) Source #

The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

objectiveStatusCounters_pending :: Lens' ObjectiveStatusCounters (Maybe Natural) Source #

The number of training jobs that are in progress and pending evaluation of their final objective metric.

objectiveStatusCounters_succeeded :: Lens' ObjectiveStatusCounters (Maybe Natural) Source #

The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

OfflineStoreConfig

offlineStoreConfig_dataCatalogConfig :: Lens' OfflineStoreConfig (Maybe DataCatalogConfig) Source #

The meta data of the Glue table that is autogenerated when an OfflineStore is created.

offlineStoreConfig_disableGlueTableCreation :: Lens' OfflineStoreConfig (Maybe Bool) Source #

Set to True to disable the automatic creation of an Amazon Web Services Glue table when configuring an OfflineStore.

offlineStoreConfig_tableFormat :: Lens' OfflineStoreConfig (Maybe TableFormat) Source #

Format for the offline store table. Supported formats are Glue (Default) and Apache Iceberg.

offlineStoreConfig_s3StorageConfig :: Lens' OfflineStoreConfig S3StorageConfig Source #

The Amazon Simple Storage (Amazon S3) location of OfflineStore.

OfflineStoreStatus

offlineStoreStatus_blockedReason :: Lens' OfflineStoreStatus (Maybe Text) Source #

The justification for why the OfflineStoreStatus is Blocked (if applicable).

offlineStoreStatus_status :: Lens' OfflineStoreStatus OfflineStoreStatusValue Source #

An OfflineStore status.

OidcConfig

oidcConfig_clientId :: Lens' OidcConfig Text Source #

The OIDC IdP client ID used to configure your private workforce.

oidcConfig_clientSecret :: Lens' OidcConfig Text Source #

The OIDC IdP client secret used to configure your private workforce.

oidcConfig_issuer :: Lens' OidcConfig Text Source #

The OIDC IdP issuer used to configure your private workforce.

oidcConfig_authorizationEndpoint :: Lens' OidcConfig Text Source #

The OIDC IdP authorization endpoint used to configure your private workforce.

oidcConfig_tokenEndpoint :: Lens' OidcConfig Text Source #

The OIDC IdP token endpoint used to configure your private workforce.

oidcConfig_userInfoEndpoint :: Lens' OidcConfig Text Source #

The OIDC IdP user information endpoint used to configure your private workforce.

oidcConfig_logoutEndpoint :: Lens' OidcConfig Text Source #

The OIDC IdP logout endpoint used to configure your private workforce.

oidcConfig_jwksUri :: Lens' OidcConfig Text Source #

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

OidcConfigForResponse

oidcConfigForResponse_authorizationEndpoint :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP authorization endpoint used to configure your private workforce.

oidcConfigForResponse_clientId :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP client ID used to configure your private workforce.

oidcConfigForResponse_issuer :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP issuer used to configure your private workforce.

oidcConfigForResponse_jwksUri :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP JSON Web Key Set (Jwks) URI used to configure your private workforce.

oidcConfigForResponse_logoutEndpoint :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP logout endpoint used to configure your private workforce.

oidcConfigForResponse_tokenEndpoint :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP token endpoint used to configure your private workforce.

oidcConfigForResponse_userInfoEndpoint :: Lens' OidcConfigForResponse (Maybe Text) Source #

The OIDC IdP user information endpoint used to configure your private workforce.

OidcMemberDefinition

oidcMemberDefinition_groups :: Lens' OidcMemberDefinition (NonEmpty Text) Source #

A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.

OnlineStoreConfig

onlineStoreConfig_enableOnlineStore :: Lens' OnlineStoreConfig (Maybe Bool) Source #

Turn OnlineStore off by specifying False for the EnableOnlineStore flag. Turn OnlineStore on by specifying True for the EnableOnlineStore flag.

The default value is False.

onlineStoreConfig_securityConfig :: Lens' OnlineStoreConfig (Maybe OnlineStoreSecurityConfig) Source #

Use to specify KMS Key ID (KMSKeyId) for at-rest encryption of your OnlineStore.

OnlineStoreSecurityConfig

onlineStoreSecurityConfig_kmsKeyId :: Lens' OnlineStoreSecurityConfig (Maybe Text) Source #

The ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.

The caller (either IAM user or IAM role) of CreateFeatureGroup must have below permissions to the OnlineStore KmsKeyId:

  • "kms:Encrypt"
  • "kms:Decrypt"
  • "kms:DescribeKey"
  • "kms:CreateGrant"
  • "kms:RetireGrant"
  • "kms:ReEncryptFrom"
  • "kms:ReEncryptTo"
  • "kms:GenerateDataKey"
  • "kms:ListAliases"
  • "kms:ListGrants"
  • "kms:RevokeGrant"

The caller (either IAM user or IAM role) to all DataPlane operations (PutRecord, GetRecord, DeleteRecord) must have the following permissions to the KmsKeyId:

  • "kms:Decrypt"

OutputConfig

outputConfig_compilerOptions :: Lens' OutputConfig (Maybe Text) Source #

Specifies additional parameters for compiler options in JSON format. The compiler options are TargetPlatform specific. It is required for NVIDIA accelerators and highly recommended for CPU compilations. For any other cases, it is optional to specify CompilerOptions.

  • DTYPE: Specifies the data type for the input. When compiling for ml_* (except for ml_inf) instances using PyTorch framework, provide the data type (dtype) of the model's input. "float32" is used if "DTYPE" is not specified. Options for data type are:

    • float32: Use either "float" or "float32".
    • int64: Use either "int64" or "long".

    For example, {"dtype" : "float32"}.

  • CPU: Compilation for CPU supports the following compiler options.

    • mcpu: CPU micro-architecture. For example, {'mcpu': 'skylake-avx512'}
    • mattr: CPU flags. For example, {'mattr': ['+neon', '+vfpv4']}

  • ARM: Details of ARM CPU compilations.

    • NEON: NEON is an implementation of the Advanced SIMD extension used in ARMv7 processors.

      For example, add {'mattr': ['+neon']} to the compiler options if compiling for ARM 32-bit platform with the NEON support.

  • NVIDIA: Compilation for NVIDIA GPU supports the following compiler options.

    • gpu_code: Specifies the targeted architecture.
    • trt-ver: Specifies the TensorRT versions in x.y.z. format.
    • cuda-ver: Specifies the CUDA version in x.y format.

    For example, {'gpu-code': 'sm_72', 'trt-ver': '6.0.1', 'cuda-ver': '10.1'}

  • ANDROID: Compilation for the Android OS supports the following compiler options:

    • ANDROID_PLATFORM: Specifies the Android API levels. Available levels range from 21 to 29. For example, {'ANDROID_PLATFORM': 28}.
    • mattr: Add {'mattr': ['+neon']} to compiler options if compiling for ARM 32-bit platform with NEON support.

  • INFERENTIA: Compilation for target ml_inf1 uses compiler options passed in as a JSON string. For example, "CompilerOptions": "\"--verbose 1 --num-neuroncores 2 -O2\"".

    For information about supported compiler options, see Neuron Compiler CLI.

  • CoreML: Compilation for the CoreML OutputConfig$TargetDevice supports the following compiler options:

    • class_labels: Specifies the classification labels file name inside input tar.gz file. For example, {"class_labels": "imagenet_labels_1000.txt"}. Labels inside the txt file should be separated by newlines.

  • EIA: Compilation for the Elastic Inference Accelerator supports the following compiler options:

    • precision_mode: Specifies the precision of compiled artifacts. Supported values are "FP16" and "FP32". Default is "FP32".
    • signature_def_key: Specifies the signature to use for models in SavedModel format. Defaults is TensorFlow's default signature def key.
    • output_names: Specifies a list of output tensor names for models in FrozenGraph format. Set at most one API field, either: signature_def_key or output_names.

    For example: {"precision_mode": "FP32", "output_names": ["output:0"]}

outputConfig_kmsKeyId :: Lens' OutputConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

outputConfig_targetDevice :: Lens' OutputConfig (Maybe TargetDevice) Source #

Identifies the target device or the machine learning instance that you want to run your model on after the compilation has completed. Alternatively, you can specify OS, architecture, and accelerator using TargetPlatform fields. It can be used instead of TargetPlatform.

outputConfig_targetPlatform :: Lens' OutputConfig (Maybe TargetPlatform) Source #

Contains information about a target platform that you want your model to run on, such as OS, architecture, and accelerators. It is an alternative of TargetDevice.

The following examples show how to configure the TargetPlatform and CompilerOptions JSON strings for popular target platforms:

  • Raspberry Pi 3 Model B+

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM_EABIHF"},
     "CompilerOptions": {'mattr': ['+neon']}

  • Jetson TX2

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "NVIDIA"},
     "CompilerOptions": {'gpu-code': 'sm_62', 'trt-ver': '6.0.1', 'cuda-ver': '10.0'}

  • EC2 m5.2xlarge instance OS

    "TargetPlatform": {"Os": "LINUX", "Arch": "X86_64", "Accelerator": "NVIDIA"},
     "CompilerOptions": {'mcpu': 'skylake-avx512'}

  • RK3399

    "TargetPlatform": {"Os": "LINUX", "Arch": "ARM64", "Accelerator": "MALI"}

  • ARMv7 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM_EABI"},
     "CompilerOptions": {'ANDROID_PLATFORM': 25, 'mattr': ['+neon']}

  • ARMv8 phone (CPU)

    "TargetPlatform": {"Os": "ANDROID", "Arch": "ARM64"},
     "CompilerOptions": {'ANDROID_PLATFORM': 29}

outputConfig_s3OutputLocation :: Lens' OutputConfig Text Source #

Identifies the S3 bucket where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

OutputDataConfig

outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

outputDataConfig_s3OutputPath :: Lens' OutputDataConfig Text Source #

Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

OutputParameter

outputParameter_name :: Lens' OutputParameter Text Source #

The name of the output parameter.

outputParameter_value :: Lens' OutputParameter Text Source #

The value of the output parameter.

ParallelismConfiguration

parallelismConfiguration_maxParallelExecutionSteps :: Lens' ParallelismConfiguration Natural Source #

The max number of steps that can be executed in parallel.

Parameter

parameter_name :: Lens' Parameter Text Source #

The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.

parameter_value :: Lens' Parameter Text Source #

The literal value for the parameter.

ParameterRange

parameterRange_categoricalParameterRangeSpecification :: Lens' ParameterRange (Maybe CategoricalParameterRangeSpecification) Source #

A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

parameterRange_continuousParameterRangeSpecification :: Lens' ParameterRange (Maybe ContinuousParameterRangeSpecification) Source #

A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

parameterRange_integerParameterRangeSpecification :: Lens' ParameterRange (Maybe IntegerParameterRangeSpecification) Source #

A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

ParameterRanges

parameterRanges_categoricalParameterRanges :: Lens' ParameterRanges (Maybe [CategoricalParameterRange]) Source #

The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

parameterRanges_continuousParameterRanges :: Lens' ParameterRanges (Maybe [ContinuousParameterRange]) Source #

The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

parameterRanges_integerParameterRanges :: Lens' ParameterRanges (Maybe [IntegerParameterRange]) Source #

The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

Parent

parent_experimentName :: Lens' Parent (Maybe Text) Source #

The name of the experiment.

parent_trialName :: Lens' Parent (Maybe Text) Source #

The name of the trial.

ParentHyperParameterTuningJob

parentHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' ParentHyperParameterTuningJob (Maybe Text) Source #

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

PendingDeploymentSummary

pendingDeploymentSummary_productionVariants :: Lens' PendingDeploymentSummary (Maybe (NonEmpty PendingProductionVariantSummary)) Source #

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint for the in-progress deployment.

pendingDeploymentSummary_shadowProductionVariants :: Lens' PendingDeploymentSummary (Maybe (NonEmpty PendingProductionVariantSummary)) Source #

An array of PendingProductionVariantSummary objects, one for each model hosted behind this endpoint in shadow mode with production traffic replicated from the model specified on ProductionVariants for the in-progress deployment.

pendingDeploymentSummary_startTime :: Lens' PendingDeploymentSummary (Maybe UTCTime) Source #

The start time of the deployment.

pendingDeploymentSummary_endpointConfigName :: Lens' PendingDeploymentSummary Text Source #

The name of the endpoint configuration used in the deployment.

PendingProductionVariantSummary

pendingProductionVariantSummary_acceleratorType :: Lens' PendingProductionVariantSummary (Maybe ProductionVariantAcceleratorType) Source #

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

pendingProductionVariantSummary_currentInstanceCount :: Lens' PendingProductionVariantSummary (Maybe Natural) Source #

The number of instances associated with the variant.

pendingProductionVariantSummary_currentServerlessConfig :: Lens' PendingProductionVariantSummary (Maybe ProductionVariantServerlessConfig) Source #

The serverless configuration for the endpoint.

pendingProductionVariantSummary_currentWeight :: Lens' PendingProductionVariantSummary (Maybe Double) Source #

The weight associated with the variant.

pendingProductionVariantSummary_deployedImages :: Lens' PendingProductionVariantSummary (Maybe [DeployedImage]) Source #

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

pendingProductionVariantSummary_desiredInstanceCount :: Lens' PendingProductionVariantSummary (Maybe Natural) Source #

The number of instances requested in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

pendingProductionVariantSummary_desiredServerlessConfig :: Lens' PendingProductionVariantSummary (Maybe ProductionVariantServerlessConfig) Source #

The serverless configuration requested for this deployment, as specified in the endpoint configuration for the endpoint.

pendingProductionVariantSummary_desiredWeight :: Lens' PendingProductionVariantSummary (Maybe Double) Source #

The requested weight for the variant in this deployment, as specified in the endpoint configuration for the endpoint. The value is taken from the request to the CreateEndpointConfig operation.

pendingProductionVariantSummary_instanceType :: Lens' PendingProductionVariantSummary (Maybe ProductionVariantInstanceType) Source #

The type of instances associated with the variant.

pendingProductionVariantSummary_variantStatus :: Lens' PendingProductionVariantSummary (Maybe [ProductionVariantStatus]) Source #

The endpoint variant status which describes the current deployment stage status or operational status.

pendingProductionVariantSummary_variantName :: Lens' PendingProductionVariantSummary Text Source #

The name of the variant.

Phase

phase_durationInSeconds :: Lens' Phase (Maybe Natural) Source #

Specifies how long traffic phase should be.

phase_initialNumberOfUsers :: Lens' Phase (Maybe Natural) Source #

Specifies how many concurrent users to start with.

phase_spawnRate :: Lens' Phase (Maybe Natural) Source #

Specified how many new users to spawn in a minute.

Pipeline

pipeline_createdBy :: Lens' Pipeline (Maybe UserContext) Source #

Undocumented member.

pipeline_creationTime :: Lens' Pipeline (Maybe UTCTime) Source #

The creation time of the pipeline.

pipeline_lastModifiedBy :: Lens' Pipeline (Maybe UserContext) Source #

Undocumented member.

pipeline_lastModifiedTime :: Lens' Pipeline (Maybe UTCTime) Source #

The time that the pipeline was last modified.

pipeline_lastRunTime :: Lens' Pipeline (Maybe UTCTime) Source #

The time when the pipeline was last run.

pipeline_parallelismConfiguration :: Lens' Pipeline (Maybe ParallelismConfiguration) Source #

The parallelism configuration applied to the pipeline.

pipeline_pipelineArn :: Lens' Pipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline.

pipeline_pipelineDescription :: Lens' Pipeline (Maybe Text) Source #

The description of the pipeline.

pipeline_pipelineDisplayName :: Lens' Pipeline (Maybe Text) Source #

The display name of the pipeline.

pipeline_pipelineName :: Lens' Pipeline (Maybe Text) Source #

The name of the pipeline.

pipeline_pipelineStatus :: Lens' Pipeline (Maybe PipelineStatus) Source #

The status of the pipeline.

pipeline_roleArn :: Lens' Pipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role that created the pipeline.

pipeline_tags :: Lens' Pipeline (Maybe [Tag]) Source #

A list of tags that apply to the pipeline.

PipelineDefinitionS3Location

pipelineDefinitionS3Location_versionId :: Lens' PipelineDefinitionS3Location (Maybe Text) Source #

Version Id of the pipeline definition file. If not specified, Amazon SageMaker will retrieve the latest version.

pipelineDefinitionS3Location_bucket :: Lens' PipelineDefinitionS3Location Text Source #

Name of the S3 bucket.

pipelineDefinitionS3Location_objectKey :: Lens' PipelineDefinitionS3Location Text Source #

The object key (or key name) uniquely identifies the object in an S3 bucket.

PipelineExecution

pipelineExecution_createdBy :: Lens' PipelineExecution (Maybe UserContext) Source #

Undocumented member.

pipelineExecution_creationTime :: Lens' PipelineExecution (Maybe UTCTime) Source #

The creation time of the pipeline execution.

pipelineExecution_failureReason :: Lens' PipelineExecution (Maybe Text) Source #

If the execution failed, a message describing why.

pipelineExecution_lastModifiedBy :: Lens' PipelineExecution (Maybe UserContext) Source #

Undocumented member.

pipelineExecution_lastModifiedTime :: Lens' PipelineExecution (Maybe UTCTime) Source #

The time that the pipeline execution was last modified.

pipelineExecution_parallelismConfiguration :: Lens' PipelineExecution (Maybe ParallelismConfiguration) Source #

The parallelism configuration applied to the pipeline execution.

pipelineExecution_pipelineArn :: Lens' PipelineExecution (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline that was executed.

pipelineExecution_pipelineExecutionArn :: Lens' PipelineExecution (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

pipelineExecution_pipelineExecutionDescription :: Lens' PipelineExecution (Maybe Text) Source #

The description of the pipeline execution.

pipelineExecution_pipelineExecutionDisplayName :: Lens' PipelineExecution (Maybe Text) Source #

The display name of the pipeline execution.

pipelineExecution_pipelineExecutionStatus :: Lens' PipelineExecution (Maybe PipelineExecutionStatus) Source #

The status of the pipeline status.

pipelineExecution_pipelineExperimentConfig :: Lens' PipelineExecution (Maybe PipelineExperimentConfig) Source #

Undocumented member.

pipelineExecution_pipelineParameters :: Lens' PipelineExecution (Maybe [Parameter]) Source #

Contains a list of pipeline parameters. This list can be empty.

PipelineExecutionStep

pipelineExecutionStep_attemptCount :: Lens' PipelineExecutionStep (Maybe Int) Source #

The current attempt of the execution step. For more information, see Retry Policy for SageMaker Pipelines steps.

pipelineExecutionStep_cacheHitResult :: Lens' PipelineExecutionStep (Maybe CacheHitResult) Source #

If this pipeline execution step was cached, details on the cache hit.

pipelineExecutionStep_endTime :: Lens' PipelineExecutionStep (Maybe UTCTime) Source #

The time that the step stopped executing.

pipelineExecutionStep_failureReason :: Lens' PipelineExecutionStep (Maybe Text) Source #

The reason why the step failed execution. This is only returned if the step failed its execution.

pipelineExecutionStep_metadata :: Lens' PipelineExecutionStep (Maybe PipelineExecutionStepMetadata) Source #

Metadata to run the pipeline step.

pipelineExecutionStep_startTime :: Lens' PipelineExecutionStep (Maybe UTCTime) Source #

The time that the step started executing.

pipelineExecutionStep_stepDescription :: Lens' PipelineExecutionStep (Maybe Text) Source #

The description of the step.

pipelineExecutionStep_stepDisplayName :: Lens' PipelineExecutionStep (Maybe Text) Source #

The display name of the step.

pipelineExecutionStep_stepName :: Lens' PipelineExecutionStep (Maybe Text) Source #

The name of the step that is executed.

pipelineExecutionStep_stepStatus :: Lens' PipelineExecutionStep (Maybe StepStatus) Source #

The status of the step execution.

PipelineExecutionStepMetadata

pipelineExecutionStepMetadata_autoMLJob :: Lens' PipelineExecutionStepMetadata (Maybe AutoMLJobStepMetadata) Source #

The Amazon Resource Name (ARN) of the AutoML job that was run by this step.

pipelineExecutionStepMetadata_callback :: Lens' PipelineExecutionStepMetadata (Maybe CallbackStepMetadata) Source #

The URL of the Amazon SQS queue used by this step execution, the pipeline generated token, and a list of output parameters.

pipelineExecutionStepMetadata_clarifyCheck :: Lens' PipelineExecutionStepMetadata (Maybe ClarifyCheckStepMetadata) Source #

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.

pipelineExecutionStepMetadata_condition :: Lens' PipelineExecutionStepMetadata (Maybe ConditionStepMetadata) Source #

The outcome of the condition evaluation that was run by this step execution.

pipelineExecutionStepMetadata_emr :: Lens' PipelineExecutionStepMetadata (Maybe EMRStepMetadata) Source #

The configurations and outcomes of an Amazon EMR step execution.

pipelineExecutionStepMetadata_fail :: Lens' PipelineExecutionStepMetadata (Maybe FailStepMetadata) Source #

The configurations and outcomes of a Fail step execution.

pipelineExecutionStepMetadata_lambda :: Lens' PipelineExecutionStepMetadata (Maybe LambdaStepMetadata) Source #

The Amazon Resource Name (ARN) of the Lambda function that was run by this step execution and a list of output parameters.

pipelineExecutionStepMetadata_model :: Lens' PipelineExecutionStepMetadata (Maybe ModelStepMetadata) Source #

The Amazon Resource Name (ARN) of the model that was created by this step execution.

pipelineExecutionStepMetadata_processingJob :: Lens' PipelineExecutionStepMetadata (Maybe ProcessingJobStepMetadata) Source #

The Amazon Resource Name (ARN) of the processing job that was run by this step execution.

pipelineExecutionStepMetadata_qualityCheck :: Lens' PipelineExecutionStepMetadata (Maybe QualityCheckStepMetadata) Source #

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.

pipelineExecutionStepMetadata_registerModel :: Lens' PipelineExecutionStepMetadata (Maybe RegisterModelStepMetadata) Source #

The Amazon Resource Name (ARN) of the model package that the model was registered to by this step execution.

pipelineExecutionStepMetadata_trainingJob :: Lens' PipelineExecutionStepMetadata (Maybe TrainingJobStepMetadata) Source #

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

pipelineExecutionStepMetadata_transformJob :: Lens' PipelineExecutionStepMetadata (Maybe TransformJobStepMetadata) Source #

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

pipelineExecutionStepMetadata_tuningJob :: Lens' PipelineExecutionStepMetadata (Maybe TuningJobStepMetaData) Source #

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

PipelineExecutionSummary

pipelineExecutionSummary_pipelineExecutionArn :: Lens' PipelineExecutionSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline execution.

pipelineExecutionSummary_pipelineExecutionDescription :: Lens' PipelineExecutionSummary (Maybe Text) Source #

The description of the pipeline execution.

pipelineExecutionSummary_pipelineExecutionDisplayName :: Lens' PipelineExecutionSummary (Maybe Text) Source #

The display name of the pipeline execution.

pipelineExecutionSummary_pipelineExecutionFailureReason :: Lens' PipelineExecutionSummary (Maybe Text) Source #

A message generated by SageMaker Pipelines describing why the pipeline execution failed.

pipelineExecutionSummary_pipelineExecutionStatus :: Lens' PipelineExecutionSummary (Maybe PipelineExecutionStatus) Source #

The status of the pipeline execution.

pipelineExecutionSummary_startTime :: Lens' PipelineExecutionSummary (Maybe UTCTime) Source #

The start time of the pipeline execution.

PipelineExperimentConfig

pipelineExperimentConfig_experimentName :: Lens' PipelineExperimentConfig (Maybe Text) Source #

The name of the experiment.

pipelineExperimentConfig_trialName :: Lens' PipelineExperimentConfig (Maybe Text) Source #

The name of the trial.

PipelineSummary

pipelineSummary_creationTime :: Lens' PipelineSummary (Maybe UTCTime) Source #

The creation time of the pipeline.

pipelineSummary_lastExecutionTime :: Lens' PipelineSummary (Maybe UTCTime) Source #

The last time that a pipeline execution began.

pipelineSummary_lastModifiedTime :: Lens' PipelineSummary (Maybe UTCTime) Source #

The time that the pipeline was last modified.

pipelineSummary_pipelineArn :: Lens' PipelineSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the pipeline.

pipelineSummary_pipelineDescription :: Lens' PipelineSummary (Maybe Text) Source #

The description of the pipeline.

pipelineSummary_pipelineDisplayName :: Lens' PipelineSummary (Maybe Text) Source #

The display name of the pipeline.

pipelineSummary_pipelineName :: Lens' PipelineSummary (Maybe Text) Source #

The name of the pipeline.

pipelineSummary_roleArn :: Lens' PipelineSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) that the pipeline used to execute.

ProcessingClusterConfig

processingClusterConfig_volumeKmsKeyId :: Lens' ProcessingClusterConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

processingClusterConfig_instanceCount :: Lens' ProcessingClusterConfig Natural Source #

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

processingClusterConfig_instanceType :: Lens' ProcessingClusterConfig ProcessingInstanceType Source #

The ML compute instance type for the processing job.

processingClusterConfig_volumeSizeInGB :: Lens' ProcessingClusterConfig Natural Source #

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes.

ProcessingFeatureStoreOutput

processingFeatureStoreOutput_featureGroupName :: Lens' ProcessingFeatureStoreOutput Text Source #

The name of the Amazon SageMaker FeatureGroup to use as the destination for processing job output. Note that your processing script is responsible for putting records into your Feature Store.

ProcessingInput

processingInput_appManaged :: Lens' ProcessingInput (Maybe Bool) Source #

When True, input operations such as data download are managed natively by the processing job application. When False (default), input operations are managed by Amazon SageMaker.

processingInput_datasetDefinition :: Lens' ProcessingInput (Maybe DatasetDefinition) Source #

Configuration for a Dataset Definition input.

processingInput_s3Input :: Lens' ProcessingInput (Maybe ProcessingS3Input) Source #

Configuration for downloading input data from Amazon S3 into the processing container.

processingInput_inputName :: Lens' ProcessingInput Text Source #

The name for the processing job input.

ProcessingJob

processingJob_appSpecification :: Lens' ProcessingJob (Maybe AppSpecification) Source #

Undocumented member.

processingJob_autoMLJobArn :: Lens' ProcessingJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.

processingJob_creationTime :: Lens' ProcessingJob (Maybe UTCTime) Source #

The time the processing job was created.

processingJob_environment :: Lens' ProcessingJob (Maybe (HashMap Text Text)) Source #

Sets the environment variables in the Docker container.

processingJob_exitMessage :: Lens' ProcessingJob (Maybe Text) Source #

A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

processingJob_experimentConfig :: Lens' ProcessingJob (Maybe ExperimentConfig) Source #

Undocumented member.

processingJob_failureReason :: Lens' ProcessingJob (Maybe Text) Source #

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

processingJob_lastModifiedTime :: Lens' ProcessingJob (Maybe UTCTime) Source #

The time the processing job was last modified.

processingJob_monitoringScheduleArn :: Lens' ProcessingJob (Maybe Text) Source #

The ARN of a monitoring schedule for an endpoint associated with this processing job.

processingJob_networkConfig :: Lens' ProcessingJob (Maybe NetworkConfig) Source #

Undocumented member.

processingJob_processingEndTime :: Lens' ProcessingJob (Maybe UTCTime) Source #

The time that the processing job ended.

processingJob_processingInputs :: Lens' ProcessingJob (Maybe [ProcessingInput]) Source #

List of input configurations for the processing job.

processingJob_processingJobArn :: Lens' ProcessingJob (Maybe Text) Source #

The ARN of the processing job.

processingJob_processingJobName :: Lens' ProcessingJob (Maybe Text) Source #

The name of the processing job.

processingJob_processingJobStatus :: Lens' ProcessingJob (Maybe ProcessingJobStatus) Source #

The status of the processing job.

processingJob_processingOutputConfig :: Lens' ProcessingJob (Maybe ProcessingOutputConfig) Source #

Undocumented member.

processingJob_processingResources :: Lens' ProcessingJob (Maybe ProcessingResources) Source #

Undocumented member.

processingJob_processingStartTime :: Lens' ProcessingJob (Maybe UTCTime) Source #

The time that the processing job started.

processingJob_roleArn :: Lens' ProcessingJob (Maybe Text) Source #

The ARN of the role used to create the processing job.

processingJob_stoppingCondition :: Lens' ProcessingJob (Maybe ProcessingStoppingCondition) Source #

Undocumented member.

processingJob_tags :: Lens' ProcessingJob (Maybe [Tag]) Source #

An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

processingJob_trainingJobArn :: Lens' ProcessingJob (Maybe Text) Source #

The ARN of the training job associated with this processing job.

ProcessingJobStepMetadata

processingJobStepMetadata_arn :: Lens' ProcessingJobStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the processing job.

ProcessingJobSummary

processingJobSummary_exitMessage :: Lens' ProcessingJobSummary (Maybe Text) Source #

An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.

processingJobSummary_failureReason :: Lens' ProcessingJobSummary (Maybe Text) Source #

A string, up to one KB in size, that contains the reason a processing job failed, if it failed.

processingJobSummary_lastModifiedTime :: Lens' ProcessingJobSummary (Maybe UTCTime) Source #

A timestamp that indicates the last time the processing job was modified.

processingJobSummary_processingEndTime :: Lens' ProcessingJobSummary (Maybe UTCTime) Source #

The time at which the processing job completed.

processingJobSummary_processingJobName :: Lens' ProcessingJobSummary Text Source #

The name of the processing job.

processingJobSummary_processingJobArn :: Lens' ProcessingJobSummary Text Source #

The Amazon Resource Name (ARN) of the processing job..

processingJobSummary_creationTime :: Lens' ProcessingJobSummary UTCTime Source #

The time at which the processing job was created.

processingJobSummary_processingJobStatus :: Lens' ProcessingJobSummary ProcessingJobStatus Source #

The status of the processing job.

ProcessingOutput

processingOutput_appManaged :: Lens' ProcessingOutput (Maybe Bool) Source #

When True, output operations such as data upload are managed natively by the processing job application. When False (default), output operations are managed by Amazon SageMaker.

processingOutput_featureStoreOutput :: Lens' ProcessingOutput (Maybe ProcessingFeatureStoreOutput) Source #

Configuration for processing job outputs in Amazon SageMaker Feature Store. This processing output type is only supported when AppManaged is specified.

processingOutput_s3Output :: Lens' ProcessingOutput (Maybe ProcessingS3Output) Source #

Configuration for processing job outputs in Amazon S3.

processingOutput_outputName :: Lens' ProcessingOutput Text Source #

The name for the processing job output.

ProcessingOutputConfig

processingOutputConfig_kmsKeyId :: Lens' ProcessingOutputConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the processing job output. KmsKeyId can be an ID of a KMS key, ARN of a KMS key, alias of a KMS key, or alias of a KMS key. The KmsKeyId is applied to all outputs.

processingOutputConfig_outputs :: Lens' ProcessingOutputConfig [ProcessingOutput] Source #

An array of outputs configuring the data to upload from the processing container.

ProcessingResources

processingResources_clusterConfig :: Lens' ProcessingResources ProcessingClusterConfig Source #

The configuration for the resources in a cluster used to run the processing job.

ProcessingS3Input

processingS3Input_localPath :: Lens' ProcessingS3Input (Maybe Text) Source #

The local path in your container where you want Amazon SageMaker to write input data to. LocalPath is an absolute path to the input data and must begin with /opt/ml/processing/. LocalPath is a required parameter when AppManaged is False (default).

processingS3Input_s3CompressionType :: Lens' ProcessingS3Input (Maybe ProcessingS3CompressionType) Source #

Whether to GZIP-decompress the data in Amazon S3 as it is streamed into the processing container. Gzip can only be used when Pipe mode is specified as the S3InputMode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your container without using the EBS volume.

processingS3Input_s3DataDistributionType :: Lens' ProcessingS3Input (Maybe ProcessingS3DataDistributionType) Source #

Whether to distribute the data from Amazon S3 to all processing instances with FullyReplicated, or whether the data from Amazon S3 is shared by Amazon S3 key, downloading one shard of data to each processing instance.

processingS3Input_s3InputMode :: Lens' ProcessingS3Input (Maybe ProcessingS3InputMode) Source #

Whether to use File or Pipe input mode. In File mode, Amazon SageMaker copies the data from the input source onto the local ML storage volume before starting your processing container. This is the most commonly used input mode. In Pipe mode, Amazon SageMaker streams input data from the source directly to your processing container into named pipes without using the ML storage volume.

processingS3Input_s3Uri :: Lens' ProcessingS3Input Text Source #

The URI of the Amazon S3 prefix Amazon SageMaker downloads data required to run a processing job.

processingS3Input_s3DataType :: Lens' ProcessingS3Input ProcessingS3DataType Source #

Whether you use an S3Prefix or a ManifestFile for the data type. If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for the processing job. If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for the processing job.

ProcessingS3Output

processingS3Output_s3Uri :: Lens' ProcessingS3Output Text Source #

A URI that identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of a processing job.

processingS3Output_localPath :: Lens' ProcessingS3Output Text Source #

The local path of a directory where you want Amazon SageMaker to upload its contents to Amazon S3. LocalPath is an absolute path to a directory containing output files. This directory will be created by the platform and exist when your container's entrypoint is invoked.

processingS3Output_s3UploadMode :: Lens' ProcessingS3Output ProcessingS3UploadMode Source #

Whether to upload the results of the processing job continuously or after the job completes.

ProcessingStoppingCondition

processingStoppingCondition_maxRuntimeInSeconds :: Lens' ProcessingStoppingCondition Natural Source #

Specifies the maximum runtime in seconds.

ProductionVariant

productionVariant_acceleratorType :: Lens' ProductionVariant (Maybe ProductionVariantAcceleratorType) Source #

The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

productionVariant_containerStartupHealthCheckTimeoutInSeconds :: Lens' ProductionVariant (Maybe Natural) Source #

The timeout value, in seconds, for your inference container to pass health check by SageMaker Hosting. For more information about health check, see How Your Container Should Respond to Health Check (Ping) Requests.

productionVariant_coreDumpConfig :: Lens' ProductionVariant (Maybe ProductionVariantCoreDumpConfig) Source #

Specifies configuration for a core dump from the model container when the process crashes.

productionVariant_initialInstanceCount :: Lens' ProductionVariant (Maybe Natural) Source #

Number of instances to launch initially.

productionVariant_initialVariantWeight :: Lens' ProductionVariant (Maybe Double) Source #

Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

productionVariant_instanceType :: Lens' ProductionVariant (Maybe ProductionVariantInstanceType) Source #

The ML compute instance type.

productionVariant_modelDataDownloadTimeoutInSeconds :: Lens' ProductionVariant (Maybe Natural) Source #

The timeout value, in seconds, to download and extract the model that you want to host from Amazon S3 to the individual inference instance associated with this production variant.

productionVariant_serverlessConfig :: Lens' ProductionVariant (Maybe ProductionVariantServerlessConfig) Source #

The serverless configuration for an endpoint. Specifies a serverless endpoint configuration instead of an instance-based endpoint configuration.

productionVariant_volumeSizeInGB :: Lens' ProductionVariant (Maybe Natural) Source #

The size, in GB, of the ML storage volume attached to individual inference instance associated with the production variant. Currenly only Amazon EBS gp2 storage volumes are supported.

productionVariant_variantName :: Lens' ProductionVariant Text Source #

The name of the production variant.

productionVariant_modelName :: Lens' ProductionVariant Text Source #

The name of the model that you want to host. This is the name that you specified when creating the model.

ProductionVariantCoreDumpConfig

productionVariantCoreDumpConfig_kmsKeyId :: Lens' ProductionVariantCoreDumpConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the core dump data at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to "aws:kms". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateEndpoint and UpdateEndpoint requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

productionVariantCoreDumpConfig_destinationS3Uri :: Lens' ProductionVariantCoreDumpConfig Text Source #

The Amazon S3 bucket to send the core dump to.

ProductionVariantServerlessConfig

productionVariantServerlessConfig_memorySizeInMB :: Lens' ProductionVariantServerlessConfig Natural Source #

The memory size of your serverless endpoint. Valid values are in 1 GB increments: 1024 MB, 2048 MB, 3072 MB, 4096 MB, 5120 MB, or 6144 MB.

productionVariantServerlessConfig_maxConcurrency :: Lens' ProductionVariantServerlessConfig Natural Source #

The maximum number of concurrent invocations your serverless endpoint can process.

ProductionVariantStatus

productionVariantStatus_startTime :: Lens' ProductionVariantStatus (Maybe UTCTime) Source #

The start time of the current status change.

productionVariantStatus_statusMessage :: Lens' ProductionVariantStatus (Maybe Text) Source #

A message that describes the status of the production variant.

productionVariantStatus_status :: Lens' ProductionVariantStatus VariantStatus Source #

The endpoint variant status which describes the current deployment stage status or operational status.

  • Creating: Creating inference resources for the production variant.
  • Deleting: Terminating inference resources for the production variant.
  • Updating: Updating capacity for the production variant.
  • ActivatingTraffic: Turning on traffic for the production variant.
  • Baking: Waiting period to monitor the CloudWatch alarms in the automatic rollback configuration.

ProductionVariantSummary

productionVariantSummary_currentInstanceCount :: Lens' ProductionVariantSummary (Maybe Natural) Source #

The number of instances associated with the variant.

productionVariantSummary_currentServerlessConfig :: Lens' ProductionVariantSummary (Maybe ProductionVariantServerlessConfig) Source #

The serverless configuration for the endpoint.

productionVariantSummary_currentWeight :: Lens' ProductionVariantSummary (Maybe Double) Source #

The weight associated with the variant.

productionVariantSummary_deployedImages :: Lens' ProductionVariantSummary (Maybe [DeployedImage]) Source #

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

productionVariantSummary_desiredInstanceCount :: Lens' ProductionVariantSummary (Maybe Natural) Source #

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

productionVariantSummary_desiredServerlessConfig :: Lens' ProductionVariantSummary (Maybe ProductionVariantServerlessConfig) Source #

The serverless configuration requested for the endpoint update.

productionVariantSummary_desiredWeight :: Lens' ProductionVariantSummary (Maybe Double) Source #

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

productionVariantSummary_variantStatus :: Lens' ProductionVariantSummary (Maybe [ProductionVariantStatus]) Source #

The endpoint variant status which describes the current deployment stage status or operational status.

productionVariantSummary_variantName :: Lens' ProductionVariantSummary Text Source #

The name of the variant.

ProfilerConfig

profilerConfig_disableProfiler :: Lens' ProfilerConfig (Maybe Bool) Source #

Configuration to turn off Amazon SageMaker Debugger's system monitoring and profiling functionality. To turn it off, set to True.

profilerConfig_profilingIntervalInMilliseconds :: Lens' ProfilerConfig (Maybe Integer) Source #

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

profilerConfig_profilingParameters :: Lens' ProfilerConfig (Maybe (HashMap Text Text)) Source #

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

profilerConfig_s3OutputPath :: Lens' ProfilerConfig (Maybe Text) Source #

Path to Amazon S3 storage location for system and framework metrics.

ProfilerConfigForUpdate

profilerConfigForUpdate_disableProfiler :: Lens' ProfilerConfigForUpdate (Maybe Bool) Source #

To turn off Amazon SageMaker Debugger monitoring and profiling while a training job is in progress, set to True.

profilerConfigForUpdate_profilingIntervalInMilliseconds :: Lens' ProfilerConfigForUpdate (Maybe Integer) Source #

A time interval for capturing system metrics in milliseconds. Available values are 100, 200, 500, 1000 (1 second), 5000 (5 seconds), and 60000 (1 minute) milliseconds. The default value is 500 milliseconds.

profilerConfigForUpdate_profilingParameters :: Lens' ProfilerConfigForUpdate (Maybe (HashMap Text Text)) Source #

Configuration information for capturing framework metrics. Available key strings for different profiling options are DetailedProfilingConfig, PythonProfilingConfig, and DataLoaderProfilingConfig. The following codes are configuration structures for the ProfilingParameters parameter. To learn more about how to configure the ProfilingParameters parameter, see Use the SageMaker and Debugger Configuration API Operations to Create, Update, and Debug Your Training Job.

profilerConfigForUpdate_s3OutputPath :: Lens' ProfilerConfigForUpdate (Maybe Text) Source #

Path to Amazon S3 storage location for system and framework metrics.

ProfilerRuleConfiguration

profilerRuleConfiguration_instanceType :: Lens' ProfilerRuleConfiguration (Maybe ProcessingInstanceType) Source #

The instance type to deploy a custom rule for profiling a training job.

profilerRuleConfiguration_localPath :: Lens' ProfilerRuleConfiguration (Maybe Text) Source #

Path to local storage location for output of rules. Defaults to /opt/ml/processing/output/rule/.

profilerRuleConfiguration_ruleParameters :: Lens' ProfilerRuleConfiguration (Maybe (HashMap Text Text)) Source #

Runtime configuration for rule container.

profilerRuleConfiguration_s3OutputPath :: Lens' ProfilerRuleConfiguration (Maybe Text) Source #

Path to Amazon S3 storage location for rules.

profilerRuleConfiguration_volumeSizeInGB :: Lens' ProfilerRuleConfiguration (Maybe Natural) Source #

The size, in GB, of the ML storage volume attached to the processing instance.

profilerRuleConfiguration_ruleConfigurationName :: Lens' ProfilerRuleConfiguration Text Source #

The name of the rule configuration. It must be unique relative to other rule configuration names.

profilerRuleConfiguration_ruleEvaluatorImage :: Lens' ProfilerRuleConfiguration Text Source #

The Amazon Elastic Container Registry Image for the managed rule evaluation.

ProfilerRuleEvaluationStatus

profilerRuleEvaluationStatus_lastModifiedTime :: Lens' ProfilerRuleEvaluationStatus (Maybe UTCTime) Source #

Timestamp when the rule evaluation status was last modified.

profilerRuleEvaluationStatus_ruleConfigurationName :: Lens' ProfilerRuleEvaluationStatus (Maybe Text) Source #

The name of the rule configuration.

profilerRuleEvaluationStatus_ruleEvaluationJobArn :: Lens' ProfilerRuleEvaluationStatus (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule evaluation job.

profilerRuleEvaluationStatus_ruleEvaluationStatus :: Lens' ProfilerRuleEvaluationStatus (Maybe RuleEvaluationStatus) Source #

Status of the rule evaluation.

profilerRuleEvaluationStatus_statusDetails :: Lens' ProfilerRuleEvaluationStatus (Maybe Text) Source #

Details from the rule evaluation.

Project

project_createdBy :: Lens' Project (Maybe UserContext) Source #

Who created the project.

project_creationTime :: Lens' Project (Maybe UTCTime) Source #

A timestamp specifying when the project was created.

project_lastModifiedBy :: Lens' Project (Maybe UserContext) Source #

Undocumented member.

project_lastModifiedTime :: Lens' Project (Maybe UTCTime) Source #

A timestamp container for when the project was last modified.

project_projectArn :: Lens' Project (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

project_projectDescription :: Lens' Project (Maybe Text) Source #

The description of the project.

project_projectId :: Lens' Project (Maybe Text) Source #

The ID of the project.

project_projectName :: Lens' Project (Maybe Text) Source #

The name of the project.

project_projectStatus :: Lens' Project (Maybe ProjectStatus) Source #

The status of the project.

project_serviceCatalogProvisionedProductDetails :: Lens' Project (Maybe ServiceCatalogProvisionedProductDetails) Source #

Undocumented member.

project_serviceCatalogProvisioningDetails :: Lens' Project (Maybe ServiceCatalogProvisioningDetails) Source #

Undocumented member.

project_tags :: Lens' Project (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

ProjectSummary

projectSummary_projectDescription :: Lens' ProjectSummary (Maybe Text) Source #

The description of the project.

projectSummary_projectName :: Lens' ProjectSummary Text Source #

The name of the project.

projectSummary_projectArn :: Lens' ProjectSummary Text Source #

The Amazon Resource Name (ARN) of the project.

projectSummary_projectId :: Lens' ProjectSummary Text Source #

The ID of the project.

projectSummary_creationTime :: Lens' ProjectSummary UTCTime Source #

The time that the project was created.

projectSummary_projectStatus :: Lens' ProjectSummary ProjectStatus Source #

The status of the project.

PropertyNameQuery

propertyNameQuery_propertyNameHint :: Lens' PropertyNameQuery Text Source #

Text that begins a property's name.

PropertyNameSuggestion

propertyNameSuggestion_propertyName :: Lens' PropertyNameSuggestion (Maybe Text) Source #

A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.

ProvisioningParameter

provisioningParameter_key :: Lens' ProvisioningParameter (Maybe Text) Source #

The key that identifies a provisioning parameter.

provisioningParameter_value :: Lens' ProvisioningParameter (Maybe Text) Source #

The value of the provisioning parameter.

PublicWorkforceTaskPrice

publicWorkforceTaskPrice_amountInUsd :: Lens' PublicWorkforceTaskPrice (Maybe USD) Source #

Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

QualityCheckStepMetadata

qualityCheckStepMetadata_baselineUsedForDriftCheckConstraints :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of the baseline constraints file used for the drift check.

qualityCheckStepMetadata_baselineUsedForDriftCheckStatistics :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of the baseline statistics file used for the drift check.

qualityCheckStepMetadata_calculatedBaselineConstraints :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of the newly calculated baseline constraints file.

qualityCheckStepMetadata_calculatedBaselineStatistics :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of the newly calculated baseline statistics file.

qualityCheckStepMetadata_checkJobArn :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Quality check processing job that was run by this step execution.

qualityCheckStepMetadata_checkType :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The type of the Quality check step.

qualityCheckStepMetadata_modelPackageGroupName :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The model package group name.

qualityCheckStepMetadata_registerNewBaseline :: Lens' QualityCheckStepMetadata (Maybe Bool) Source #

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.

qualityCheckStepMetadata_skipCheck :: Lens' QualityCheckStepMetadata (Maybe Bool) Source #

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.

qualityCheckStepMetadata_violationReport :: Lens' QualityCheckStepMetadata (Maybe Text) Source #

The Amazon S3 URI of violation report if violations are detected.

QueryFilters

queryFilters_createdAfter :: Lens' QueryFilters (Maybe UTCTime) Source #

Filter the lineage entities connected to the StartArn(s) after the create date.

queryFilters_createdBefore :: Lens' QueryFilters (Maybe UTCTime) Source #

Filter the lineage entities connected to the StartArn(s) by created date.

queryFilters_lineageTypes :: Lens' QueryFilters (Maybe [LineageType]) Source #

Filter the lineage entities connected to the StartArn(s) by the type of the lineage entity.

queryFilters_modifiedAfter :: Lens' QueryFilters (Maybe UTCTime) Source #

Filter the lineage entities connected to the StartArn(s) after the last modified date.

queryFilters_modifiedBefore :: Lens' QueryFilters (Maybe UTCTime) Source #

Filter the lineage entities connected to the StartArn(s) before the last modified date.

queryFilters_properties :: Lens' QueryFilters (Maybe (HashMap Text Text)) Source #

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

queryFilters_types :: Lens' QueryFilters (Maybe [Text]) Source #

Filter the lineage entities connected to the StartArn by type. For example: DataSet, Model, Endpoint, or ModelDeployment.

RSessionAppSettings

rSessionAppSettings_customImages :: Lens' RSessionAppSettings (Maybe [CustomImage]) Source #

A list of custom SageMaker images that are configured to run as a RSession app.

rSessionAppSettings_defaultResourceSpec :: Lens' RSessionAppSettings (Maybe ResourceSpec) Source #

Undocumented member.

RStudioServerProAppSettings

rStudioServerProAppSettings_accessStatus :: Lens' RStudioServerProAppSettings (Maybe RStudioServerProAccessStatus) Source #

Indicates whether the current user has access to the RStudioServerPro app.

rStudioServerProAppSettings_userGroup :: Lens' RStudioServerProAppSettings (Maybe RStudioServerProUserGroup) Source #

The level of permissions that the user has within the RStudioServerPro app. This value defaults to `User`. The `Admin` value allows the user access to the RStudio Administrative Dashboard.

RStudioServerProDomainSettings

rStudioServerProDomainSettings_defaultResourceSpec :: Lens' RStudioServerProDomainSettings (Maybe ResourceSpec) Source #

Undocumented member.

rStudioServerProDomainSettings_rStudioConnectUrl :: Lens' RStudioServerProDomainSettings (Maybe Text) Source #

A URL pointing to an RStudio Connect server.

rStudioServerProDomainSettings_rStudioPackageManagerUrl :: Lens' RStudioServerProDomainSettings (Maybe Text) Source #

A URL pointing to an RStudio Package Manager server.

rStudioServerProDomainSettings_domainExecutionRoleArn :: Lens' RStudioServerProDomainSettings Text Source #

The ARN of the execution role for the RStudioServerPro Domain-level app.

RStudioServerProDomainSettingsForUpdate

rStudioServerProDomainSettingsForUpdate_defaultResourceSpec :: Lens' RStudioServerProDomainSettingsForUpdate (Maybe ResourceSpec) Source #

Undocumented member.

rStudioServerProDomainSettingsForUpdate_rStudioConnectUrl :: Lens' RStudioServerProDomainSettingsForUpdate (Maybe Text) Source #

A URL pointing to an RStudio Connect server.

rStudioServerProDomainSettingsForUpdate_rStudioPackageManagerUrl :: Lens' RStudioServerProDomainSettingsForUpdate (Maybe Text) Source #

A URL pointing to an RStudio Package Manager server.

rStudioServerProDomainSettingsForUpdate_domainExecutionRoleArn :: Lens' RStudioServerProDomainSettingsForUpdate Text Source #

The execution role for the RStudioServerPro Domain-level app.

RealTimeInferenceConfig

realTimeInferenceConfig_instanceType :: Lens' RealTimeInferenceConfig InstanceType Source #

The instance type the model is deployed to.

realTimeInferenceConfig_instanceCount :: Lens' RealTimeInferenceConfig Natural Source #

The number of instances of the type specified by InstanceType.

RecommendationJobCompiledOutputConfig

recommendationJobCompiledOutputConfig_s3OutputUri :: Lens' RecommendationJobCompiledOutputConfig (Maybe Text) Source #

Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.

RecommendationJobContainerConfig

recommendationJobContainerConfig_domain :: Lens' RecommendationJobContainerConfig (Maybe Text) Source #

The machine learning domain of the model and its components.

Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING

recommendationJobContainerConfig_framework :: Lens' RecommendationJobContainerConfig (Maybe Text) Source #

The machine learning framework of the container image.

Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN

recommendationJobContainerConfig_frameworkVersion :: Lens' RecommendationJobContainerConfig (Maybe Text) Source #

The framework version of the container image.

recommendationJobContainerConfig_nearestModelName :: Lens' RecommendationJobContainerConfig (Maybe Text) Source #

The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.

Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet

recommendationJobContainerConfig_payloadConfig :: Lens' RecommendationJobContainerConfig (Maybe RecommendationJobPayloadConfig) Source #

Specifies the SamplePayloadUrl and all other sample payload-related fields.

recommendationJobContainerConfig_supportedInstanceTypes :: Lens' RecommendationJobContainerConfig (Maybe [Text]) Source #

A list of the instance types that are used to generate inferences in real-time.

recommendationJobContainerConfig_task :: Lens' RecommendationJobContainerConfig (Maybe Text) Source #

The machine learning task that the model accomplishes.

Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER

RecommendationJobInferenceBenchmark

recommendationJobInferenceBenchmark_endpointConfiguration :: Lens' RecommendationJobInferenceBenchmark (Maybe EndpointOutputConfiguration) Source #

Undocumented member.

recommendationJobInferenceBenchmark_failureReason :: Lens' RecommendationJobInferenceBenchmark (Maybe Text) Source #

The reason why a benchmark failed.

recommendationJobInferenceBenchmark_metrics :: Lens' RecommendationJobInferenceBenchmark (Maybe RecommendationMetrics) Source #

Undocumented member.

recommendationJobInferenceBenchmark_modelConfiguration :: Lens' RecommendationJobInferenceBenchmark ModelConfiguration Source #

Undocumented member.

RecommendationJobInputConfig

recommendationJobInputConfig_containerConfig :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobContainerConfig) Source #

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

recommendationJobInputConfig_endpointConfigurations :: Lens' RecommendationJobInputConfig (Maybe (NonEmpty EndpointInputConfiguration)) Source #

Specifies the endpoint configuration to use for a job.

recommendationJobInputConfig_endpoints :: Lens' RecommendationJobInputConfig (Maybe [EndpointInfo]) Source #

Existing customer endpoints on which to run an Inference Recommender job.

recommendationJobInputConfig_jobDurationInSeconds :: Lens' RecommendationJobInputConfig (Maybe Natural) Source #

Specifies the maximum duration of the job, in seconds.>

recommendationJobInputConfig_resourceLimit :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobResourceLimit) Source #

Defines the resource limit of the job.

recommendationJobInputConfig_trafficPattern :: Lens' RecommendationJobInputConfig (Maybe TrafficPattern) Source #

Specifies the traffic pattern of the job.

recommendationJobInputConfig_volumeKmsKeyId :: Lens' RecommendationJobInputConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.

The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

recommendationJobInputConfig_vpcConfig :: Lens' RecommendationJobInputConfig (Maybe RecommendationJobVpcConfig) Source #

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.

recommendationJobInputConfig_modelPackageVersionArn :: Lens' RecommendationJobInputConfig Text Source #

The Amazon Resource Name (ARN) of a versioned model package.

RecommendationJobOutputConfig

recommendationJobOutputConfig_compiledOutputConfig :: Lens' RecommendationJobOutputConfig (Maybe RecommendationJobCompiledOutputConfig) Source #

Provides information about the output configuration for the compiled model.

recommendationJobOutputConfig_kmsKeyId :: Lens' RecommendationJobOutputConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.

The KmsKeyId can be any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"

  • // KMS Key Alias

    "alias/ExampleAlias"

  • // Amazon Resource Name (ARN) of a KMS Key Alias

    "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"

For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.

RecommendationJobPayloadConfig

recommendationJobPayloadConfig_samplePayloadUrl :: Lens' RecommendationJobPayloadConfig (Maybe Text) Source #

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

recommendationJobPayloadConfig_supportedContentTypes :: Lens' RecommendationJobPayloadConfig (Maybe [Text]) Source #

The supported MIME types for the input data.

RecommendationJobResourceLimit

recommendationJobResourceLimit_maxNumberOfTests :: Lens' RecommendationJobResourceLimit (Maybe Natural) Source #

Defines the maximum number of load tests.

recommendationJobResourceLimit_maxParallelOfTests :: Lens' RecommendationJobResourceLimit (Maybe Natural) Source #

Defines the maximum number of parallel load tests.

RecommendationJobStoppingConditions

recommendationJobStoppingConditions_maxInvocations :: Lens' RecommendationJobStoppingConditions (Maybe Int) Source #

The maximum number of requests per minute expected for the endpoint.

recommendationJobStoppingConditions_modelLatencyThresholds :: Lens' RecommendationJobStoppingConditions (Maybe (NonEmpty ModelLatencyThreshold)) Source #

The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.

RecommendationJobVpcConfig

recommendationJobVpcConfig_securityGroupIds :: Lens' RecommendationJobVpcConfig (NonEmpty Text) Source #

The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

recommendationJobVpcConfig_subnets :: Lens' RecommendationJobVpcConfig (NonEmpty Text) Source #

The ID of the subnets in the VPC to which you want to connect your model.

RecommendationMetrics

recommendationMetrics_costPerHour :: Lens' RecommendationMetrics Double Source #

Defines the cost per hour for the instance.

recommendationMetrics_costPerInference :: Lens' RecommendationMetrics Double Source #

Defines the cost per inference for the instance .

recommendationMetrics_maxInvocations :: Lens' RecommendationMetrics Int Source #

The expected maximum number of requests per minute for the instance.

recommendationMetrics_modelLatency :: Lens' RecommendationMetrics Int Source #

The expected model latency at maximum invocation per minute for the instance.

RedshiftDatasetDefinition

redshiftDatasetDefinition_kmsKeyId :: Lens' RedshiftDatasetDefinition (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data from a Redshift execution.

redshiftDatasetDefinition_outputCompression :: Lens' RedshiftDatasetDefinition (Maybe RedshiftResultCompressionType) Source #

Undocumented member.

redshiftDatasetDefinition_clusterId :: Lens' RedshiftDatasetDefinition Text Source #

Undocumented member.

redshiftDatasetDefinition_database :: Lens' RedshiftDatasetDefinition Text Source #

Undocumented member.

redshiftDatasetDefinition_dbUser :: Lens' RedshiftDatasetDefinition Text Source #

Undocumented member.

redshiftDatasetDefinition_queryString :: Lens' RedshiftDatasetDefinition Text Source #

Undocumented member.

redshiftDatasetDefinition_clusterRoleArn :: Lens' RedshiftDatasetDefinition Text Source #

The IAM role attached to your Redshift cluster that Amazon SageMaker uses to generate datasets.

redshiftDatasetDefinition_outputS3Uri :: Lens' RedshiftDatasetDefinition Text Source #

The location in Amazon S3 where the Redshift query results are stored.

redshiftDatasetDefinition_outputFormat :: Lens' RedshiftDatasetDefinition RedshiftResultFormat Source #

Undocumented member.

RegisterModelStepMetadata

registerModelStepMetadata_arn :: Lens' RegisterModelStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the model package.

RenderableTask

renderableTask_input :: Lens' RenderableTask Text Source #

A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as "text": "sample text".

RenderingError

renderingError_code :: Lens' RenderingError Text Source #

A unique identifier for a specific class of errors.

renderingError_message :: Lens' RenderingError Text Source #

A human-readable message describing the error.

RepositoryAuthConfig

repositoryAuthConfig_repositoryCredentialsProviderArn :: Lens' RepositoryAuthConfig Text Source #

The Amazon Resource Name (ARN) of an Amazon Web Services Lambda function that provides credentials to authenticate to the private Docker registry where your model image is hosted. For information about how to create an Amazon Web Services Lambda function, see Create a Lambda function with the console in the Amazon Web Services Lambda Developer Guide.

ResolvedAttributes

resolvedAttributes_autoMLJobObjective :: Lens' ResolvedAttributes (Maybe AutoMLJobObjective) Source #

Undocumented member.

resolvedAttributes_completionCriteria :: Lens' ResolvedAttributes (Maybe AutoMLJobCompletionCriteria) Source #

Undocumented member.

resolvedAttributes_problemType :: Lens' ResolvedAttributes (Maybe ProblemType) Source #

The problem type.

ResourceConfig

resourceConfig_instanceCount :: Lens' ResourceConfig (Maybe Natural) Source #

The number of ML compute instances to use. For distributed training, provide a value greater than 1.

resourceConfig_instanceGroups :: Lens' ResourceConfig (Maybe [InstanceGroup]) Source #

The configuration of a heterogeneous cluster in JSON format.

resourceConfig_instanceType :: Lens' ResourceConfig (Maybe TrainingInstanceType) Source #

The ML compute instance type.

SageMaker Training on Amazon Elastic Compute Cloud (EC2) P4de instances is in preview release starting December 9th, 2022.

Amazon EC2 P4de instances (currently in preview) are powered by 8 NVIDIA A100 GPUs with 80GB high-performance HBM2e GPU memory, which accelerate the speed of training ML models that need to be trained on large datasets of high-resolution data. In this preview release, Amazon SageMaker supports ML training jobs on P4de instances (ml.p4de.24xlarge) to reduce model training time. The ml.p4de.24xlarge instances are available in the following Amazon Web Services Regions.

  • US East (N. Virginia) (us-east-1)
  • US West (Oregon) (us-west-2)

To request quota limit increase and start using P4de instances, contact the SageMaker Training service team through your account team.

resourceConfig_keepAlivePeriodInSeconds :: Lens' ResourceConfig (Maybe Natural) Source #

The duration of time in seconds to retain configured resources in a warm pool for subsequent training jobs.

resourceConfig_volumeKmsKeyId :: Lens' ResourceConfig (Maybe Text) Source #

The Amazon Web Services KMS key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be in any of the following formats:

  • // KMS Key ID

    "1234abcd-12ab-34cd-56ef-1234567890ab"

  • // Amazon Resource Name (ARN) of a KMS Key

    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

resourceConfig_volumeSizeInGB :: Lens' ResourceConfig Natural Source #

The size of the ML storage volume that you want to provision.

ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

When using an ML instance with NVMe SSD volumes, SageMaker doesn't provision Amazon EBS General Purpose SSD (gp2) storage. Available storage is fixed to the NVMe-type instance's storage capacity. SageMaker configures storage paths for training datasets, checkpoints, model artifacts, and outputs to use the entire capacity of the instance storage. For example, ML instance families with the NVMe-type instance storage include ml.p4d, ml.g4dn, and ml.g5.

When using an ML instance with the EBS-only storage option and without instance storage, you must define the size of EBS volume through VolumeSizeInGB in the ResourceConfig API. For example, ML instance families that use EBS volumes include ml.c5 and ml.p2.

To look up instance types and their instance storage types and volumes, see Amazon EC2 Instance Types.

To find the default local paths defined by the SageMaker training platform, see Amazon SageMaker Training Storage Folders for Training Datasets, Checkpoints, Model Artifacts, and Outputs.

ResourceConfigForUpdate

resourceConfigForUpdate_keepAlivePeriodInSeconds :: Lens' ResourceConfigForUpdate Natural Source #

The KeepAlivePeriodInSeconds value specified in the ResourceConfig to update.

ResourceLimits

resourceLimits_maxNumberOfTrainingJobs :: Lens' ResourceLimits (Maybe Natural) Source #

The maximum number of training jobs that a hyperparameter tuning job can launch.

resourceLimits_maxParallelTrainingJobs :: Lens' ResourceLimits Natural Source #

The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

ResourceSpec

resourceSpec_instanceType :: Lens' ResourceSpec (Maybe AppInstanceType) Source #

The instance type that the image version runs on.

JupyterServer apps only support the system value.

For KernelGateway apps, the system value is translated to ml.t3.medium. KernelGateway apps also support all other values for available instance types.

resourceSpec_lifecycleConfigArn :: Lens' ResourceSpec (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Lifecycle Configuration attached to the Resource.

resourceSpec_sageMakerImageArn :: Lens' ResourceSpec (Maybe Text) Source #

The ARN of the SageMaker image that the image version belongs to.

resourceSpec_sageMakerImageVersionArn :: Lens' ResourceSpec (Maybe Text) Source #

The ARN of the image version created on the instance.

RetentionPolicy

retentionPolicy_homeEfsFileSystem :: Lens' RetentionPolicy (Maybe RetentionType) Source #

The default is Retain, which specifies to keep the data stored on the EFS volume.

Specify Delete to delete the data stored on the EFS volume.

RetryStrategy

retryStrategy_maximumRetryAttempts :: Lens' RetryStrategy Natural Source #

The number of times to retry the job. When the job is retried, it's SecondaryStatus is changed to STARTING.

S3DataSource

s3DataSource_attributeNames :: Lens' S3DataSource (Maybe [Text]) Source #

A list of one or more attribute names to use that are found in a specified augmented manifest file.

s3DataSource_instanceGroupNames :: Lens' S3DataSource (Maybe [Text]) Source #

A list of names of instance groups that get data from the S3 data source.

s3DataSource_s3DataDistributionType :: Lens' S3DataSource (Maybe S3DataDistribution) Source #

If you want SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

If you want SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

s3DataSource_s3DataType :: Lens' S3DataSource S3DataType Source #

If you choose S3Prefix, S3Uri identifies a key name prefix. SageMaker uses all objects that match the specified key name prefix for model training.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want SageMaker to use for model training.

If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

s3DataSource_s3Uri :: Lens' S3DataSource Text Source #

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},
     "relative/path/to/custdata-1",
     "relative/path/custdata-2",
     ...
     "relative/path/custdata-N"
    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1
    s3://customer_bucket/some/prefix/relative/path/custdata-2
    ...
    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that SageMaker uses to perform tasks on your behalf.

S3StorageConfig

s3StorageConfig_kmsKeyId :: Lens' S3StorageConfig (Maybe Text) Source #

The Amazon Web Services Key Management Service (KMS) key ID of the key used to encrypt any objects written into the OfflineStore S3 location.

The IAM roleARN that is passed as a parameter to CreateFeatureGroup must have below permissions to the KmsKeyId:

  • "kms:GenerateDataKey"

s3StorageConfig_resolvedOutputS3Uri :: Lens' S3StorageConfig (Maybe Text) Source #

The S3 path where offline records are written.

s3StorageConfig_s3Uri :: Lens' S3StorageConfig Text Source #

The S3 URI, or location in Amazon S3, of OfflineStore.

S3 URIs have a format similar to the following: s3://example-bucket/prefix/.

ScheduleConfig

scheduleConfig_scheduleExpression :: Lens' ScheduleConfig Text Source #

A cron expression that describes details about the monitoring schedule.

Currently the only supported cron expressions are:

  • If you want to set the job to start every hour, please use the following:

    Hourly: cron(0 * ? * * *)

  • If you want to start the job daily:

    cron(0 [00-23] ? * * *)

For example, the following are valid cron expressions:

  • Daily at noon UTC: cron(0 12 ? * * *)
  • Daily at midnight UTC: cron(0 0 ? * * *)

To support running every 6, 12 hours, the following are also supported:

cron(0 [00-23]/[01-24] ? * * *)

For example, the following are valid cron expressions:

  • Every 12 hours, starting at 5pm UTC: cron(0 17/12 ? * * *)
  • Every two hours starting at midnight: cron(0 0/2 ? * * *)
  • Even though the cron expression is set to start at 5PM UTC, note that there could be a delay of 0-20 minutes from the actual requested time to run the execution.
  • We recommend that if you would like a daily schedule, you do not provide this parameter. Amazon SageMaker will pick a time for running every day.

SearchExpression

searchExpression_filters :: Lens' SearchExpression (Maybe (NonEmpty Filter)) Source #

A list of filter objects.

searchExpression_nestedFilters :: Lens' SearchExpression (Maybe (NonEmpty NestedFilters)) Source #

A list of nested filter objects.

searchExpression_operator :: Lens' SearchExpression (Maybe BooleanOperator) Source #

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

searchExpression_subExpressions :: Lens' SearchExpression (Maybe (NonEmpty SearchExpression)) Source #

A list of search expression objects.

SearchRecord

searchRecord_endpoint :: Lens' SearchRecord (Maybe Endpoint) Source #

Undocumented member.

searchRecord_experiment :: Lens' SearchRecord (Maybe Experiment) Source #

The properties of an experiment.

searchRecord_featureGroup :: Lens' SearchRecord (Maybe FeatureGroup) Source #

Undocumented member.

searchRecord_featureMetadata :: Lens' SearchRecord (Maybe FeatureMetadata) Source #

The feature metadata used to search through the features.

searchRecord_hyperParameterTuningJob :: Lens' SearchRecord (Maybe HyperParameterTuningJobSearchEntity) Source #

The properties of a hyperparameter tuning job.

searchRecord_model :: Lens' SearchRecord (Maybe ModelDashboardModel) Source #

Undocumented member.

searchRecord_modelCard :: Lens' SearchRecord (Maybe ModelCard) Source #

An Amazon SageMaker Model Card that documents details about a machine learning model.

searchRecord_modelPackage :: Lens' SearchRecord (Maybe ModelPackage) Source #

Undocumented member.

searchRecord_modelPackageGroup :: Lens' SearchRecord (Maybe ModelPackageGroup) Source #

Undocumented member.

searchRecord_pipeline :: Lens' SearchRecord (Maybe Pipeline) Source #

Undocumented member.

searchRecord_pipelineExecution :: Lens' SearchRecord (Maybe PipelineExecution) Source #

Undocumented member.

searchRecord_project :: Lens' SearchRecord (Maybe Project) Source #

The properties of a project.

searchRecord_trainingJob :: Lens' SearchRecord (Maybe TrainingJob) Source #

The properties of a training job.

searchRecord_trial :: Lens' SearchRecord (Maybe Trial) Source #

The properties of a trial.

searchRecord_trialComponent :: Lens' SearchRecord (Maybe TrialComponent) Source #

The properties of a trial component.

SecondaryStatusTransition

secondaryStatusTransition_endTime :: Lens' SecondaryStatusTransition (Maybe UTCTime) Source #

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

secondaryStatusTransition_statusMessage :: Lens' SecondaryStatusTransition (Maybe Text) Source #

A detailed description of the progress within a secondary status.

SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
- Starting the training job.
  • Launching requested ML instances.
  • Insufficient capacity error from EC2 while launching instances, retrying!
  • Launched instance was unhealthy, replacing it!
  • Preparing the instances for training.
Training
- Downloading the training image.
  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress
  • SecondaryStatus - Training
  • StatusMessage - Downloading the training image

secondaryStatusTransition_status :: Lens' SecondaryStatusTransition SecondaryStatus Source #

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress
- Starting - Starting the training job.
  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
  • Training - Training is in progress.
  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
- Completed - The training job has completed.
Failed
- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
Stopped
- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
  • Stopped - The training job has stopped.
Stopping
- Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances
  • PreparingTrainingStack
  • DownloadingTrainingImage

secondaryStatusTransition_startTime :: Lens' SecondaryStatusTransition UTCTime Source #

A timestamp that shows when the training job transitioned to the current secondary status state.

ServiceCatalogProvisionedProductDetails

serviceCatalogProvisionedProductDetails_provisionedProductId :: Lens' ServiceCatalogProvisionedProductDetails (Maybe Text) Source #

The ID of the provisioned product.

serviceCatalogProvisionedProductDetails_provisionedProductStatusMessage :: Lens' ServiceCatalogProvisionedProductDetails (Maybe Text) Source #

The current status of the product.

  • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.
  • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.
  • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.
  • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
  • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

ServiceCatalogProvisioningDetails

serviceCatalogProvisioningDetails_pathId :: Lens' ServiceCatalogProvisioningDetails (Maybe Text) Source #

The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path.

serviceCatalogProvisioningDetails_provisioningArtifactId :: Lens' ServiceCatalogProvisioningDetails (Maybe Text) Source #

The ID of the provisioning artifact.

serviceCatalogProvisioningDetails_provisioningParameters :: Lens' ServiceCatalogProvisioningDetails (Maybe [ProvisioningParameter]) Source #

A list of key value pairs that you specify when you provision a product.

serviceCatalogProvisioningDetails_productId :: Lens' ServiceCatalogProvisioningDetails Text Source #

The ID of the product to provision.

ServiceCatalogProvisioningUpdateDetails

serviceCatalogProvisioningUpdateDetails_provisioningArtifactId :: Lens' ServiceCatalogProvisioningUpdateDetails (Maybe Text) Source #

The ID of the provisioning artifact.

serviceCatalogProvisioningUpdateDetails_provisioningParameters :: Lens' ServiceCatalogProvisioningUpdateDetails (Maybe [ProvisioningParameter]) Source #

A list of key value pairs that you specify when you provision a product.

ShadowModeConfig

shadowModeConfig_sourceModelVariantName :: Lens' ShadowModeConfig Text Source #

The name of the production variant, which takes all the inference requests.

shadowModeConfig_shadowModelVariants :: Lens' ShadowModeConfig (NonEmpty ShadowModelVariantConfig) Source #

List of shadow variant configurations.

ShadowModelVariantConfig

shadowModelVariantConfig_shadowModelVariantName :: Lens' ShadowModelVariantConfig Text Source #

The name of the shadow variant.

shadowModelVariantConfig_samplingPercentage :: Lens' ShadowModelVariantConfig Int Source #

The percentage of inference requests that Amazon SageMaker replicates from the production variant to the shadow variant.

SharingSettings

sharingSettings_notebookOutputOption :: Lens' SharingSettings (Maybe NotebookOutputOption) Source #

Whether to include the notebook cell output when sharing the notebook. The default is Disabled.

sharingSettings_s3KmsKeyId :: Lens' SharingSettings (Maybe Text) Source #

When NotebookOutputOption is Allowed, the Amazon Web Services Key Management Service (KMS) encryption key ID used to encrypt the notebook cell output in the Amazon S3 bucket.

sharingSettings_s3OutputPath :: Lens' SharingSettings (Maybe Text) Source #

When NotebookOutputOption is Allowed, the Amazon S3 bucket used to store the shared notebook snapshots.

ShuffleConfig

shuffleConfig_seed :: Lens' ShuffleConfig Integer Source #

Determines the shuffling order in ShuffleConfig value.

SourceAlgorithm

sourceAlgorithm_modelDataUrl :: Lens' SourceAlgorithm (Maybe Text) Source #

The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

The model artifacts must be in an S3 bucket that is in the same region as the algorithm.

sourceAlgorithm_algorithmName :: Lens' SourceAlgorithm Text Source #

The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your SageMaker account or an algorithm in Amazon Web Services Marketplace that you are subscribed to.

SourceAlgorithmSpecification

sourceAlgorithmSpecification_sourceAlgorithms :: Lens' SourceAlgorithmSpecification (NonEmpty SourceAlgorithm) Source #

A list of the algorithms that were used to create a model package.

SourceIpConfig

sourceIpConfig_cidrs :: Lens' SourceIpConfig [Text] Source #

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

SpaceDetails

spaceDetails_creationTime :: Lens' SpaceDetails (Maybe UTCTime) Source #

The creation time.

spaceDetails_domainId :: Lens' SpaceDetails (Maybe Text) Source #

The ID of the associated Domain.

spaceDetails_lastModifiedTime :: Lens' SpaceDetails (Maybe UTCTime) Source #

The last modified time.

spaceDetails_spaceName :: Lens' SpaceDetails (Maybe Text) Source #

The name of the space.

spaceDetails_status :: Lens' SpaceDetails (Maybe SpaceStatus) Source #

The status.

SpaceSettings

spaceSettings_jupyterServerAppSettings :: Lens' SpaceSettings (Maybe JupyterServerAppSettings) Source #

Undocumented member.

spaceSettings_kernelGatewayAppSettings :: Lens' SpaceSettings (Maybe KernelGatewayAppSettings) Source #

Undocumented member.

StoppingCondition

stoppingCondition_maxRuntimeInSeconds :: Lens' StoppingCondition (Maybe Natural) Source #

The maximum length of time, in seconds, that a training or compilation job can run before it is stopped.

For compilation jobs, if the job does not complete during this time, a TimeOut error is generated. We recommend starting with 900 seconds and increasing as necessary based on your model.

For all other jobs, if the job does not complete during this time, SageMaker ends the job. When RetryStrategy is specified in the job request, MaxRuntimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt. The default value is 1 day. The maximum value is 28 days.

The maximum time that a TrainingJob can run in total, including any time spent publishing metrics or archiving and uploading models after it has been stopped, is 30 days.

stoppingCondition_maxWaitTimeInSeconds :: Lens' StoppingCondition (Maybe Natural) Source #

The maximum length of time, in seconds, that a managed Spot training job has to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the job can run. It must be equal to or greater than MaxRuntimeInSeconds. If the job does not complete during this time, SageMaker ends the job.

When RetryStrategy is specified in the job request, MaxWaitTimeInSeconds specifies the maximum time for all of the attempts in total, not each individual attempt.

StudioLifecycleConfigDetails

studioLifecycleConfigDetails_creationTime :: Lens' StudioLifecycleConfigDetails (Maybe UTCTime) Source #

The creation time of the Studio Lifecycle Configuration.

studioLifecycleConfigDetails_lastModifiedTime :: Lens' StudioLifecycleConfigDetails (Maybe UTCTime) Source #

This value is equivalent to CreationTime because Studio Lifecycle Configurations are immutable.

studioLifecycleConfigDetails_studioLifecycleConfigAppType :: Lens' StudioLifecycleConfigDetails (Maybe StudioLifecycleConfigAppType) Source #

The App type to which the Lifecycle Configuration is attached.

studioLifecycleConfigDetails_studioLifecycleConfigArn :: Lens' StudioLifecycleConfigDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Lifecycle Configuration.

studioLifecycleConfigDetails_studioLifecycleConfigName :: Lens' StudioLifecycleConfigDetails (Maybe Text) Source #

The name of the Studio Lifecycle Configuration.

SubscribedWorkteam

subscribedWorkteam_listingId :: Lens' SubscribedWorkteam (Maybe Text) Source #

Marketplace product listing ID.

subscribedWorkteam_marketplaceDescription :: Lens' SubscribedWorkteam (Maybe Text) Source #

The description of the vendor from the Amazon Marketplace.

subscribedWorkteam_marketplaceTitle :: Lens' SubscribedWorkteam (Maybe Text) Source #

The title of the service provided by the vendor in the Amazon Marketplace.

subscribedWorkteam_sellerName :: Lens' SubscribedWorkteam (Maybe Text) Source #

The name of the vendor in the Amazon Marketplace.

subscribedWorkteam_workteamArn :: Lens' SubscribedWorkteam Text Source #

The Amazon Resource Name (ARN) of the vendor that you have subscribed.

SuggestionQuery

suggestionQuery_propertyNameQuery :: Lens' SuggestionQuery (Maybe PropertyNameQuery) Source #

Defines a property name hint. Only property names that begin with the specified hint are included in the response.

Tag

tag_key :: Lens' Tag Text Source #

The tag key. Tag keys must be unique per resource.

tag_value :: Lens' Tag Text Source #

The tag value.

TargetPlatform

targetPlatform_accelerator :: Lens' TargetPlatform (Maybe TargetPlatformAccelerator) Source #

Specifies a target platform accelerator (optional).

  • NVIDIA: Nvidia graphics processing unit. It also requires gpu-code, trt-ver, cuda-ver compiler options
  • MALI: ARM Mali graphics processor
  • INTEL_GRAPHICS: Integrated Intel graphics

targetPlatform_os :: Lens' TargetPlatform TargetPlatformOs Source #

Specifies a target platform OS.

  • LINUX: Linux-based operating systems.
  • ANDROID: Android operating systems. Android API level can be specified using the ANDROID_PLATFORM compiler option. For example, "CompilerOptions": {'ANDROID_PLATFORM': 28}

targetPlatform_arch :: Lens' TargetPlatform TargetPlatformArch Source #

Specifies a target platform architecture.

  • X86_64: 64-bit version of the x86 instruction set.
  • X86: 32-bit version of the x86 instruction set.
  • ARM64: ARMv8 64-bit CPU.
  • ARM_EABIHF: ARMv7 32-bit, Hard Float.
  • ARM_EABI: ARMv7 32-bit, Soft Float. Used by Android 32-bit ARM platform.

TensorBoardAppSettings

tensorBoardAppSettings_defaultResourceSpec :: Lens' TensorBoardAppSettings (Maybe ResourceSpec) Source #

The default instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance.

TensorBoardOutputConfig

tensorBoardOutputConfig_localPath :: Lens' TensorBoardOutputConfig (Maybe Text) Source #

Path to local storage location for tensorBoard output. Defaults to /opt/ml/output/tensorboard.

tensorBoardOutputConfig_s3OutputPath :: Lens' TensorBoardOutputConfig Text Source #

Path to Amazon S3 storage location for TensorBoard output.

TimeSeriesForecastingSettings

timeSeriesForecastingSettings_amazonForecastRoleArn :: Lens' TimeSeriesForecastingSettings (Maybe Text) Source #

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

timeSeriesForecastingSettings_status :: Lens' TimeSeriesForecastingSettings (Maybe FeatureStatus) Source #

Describes whether time series forecasting is enabled or disabled in the Canvas app.

TrafficPattern

trafficPattern_phases :: Lens' TrafficPattern (Maybe (NonEmpty Phase)) Source #

Defines the phases traffic specification.

trafficPattern_trafficType :: Lens' TrafficPattern (Maybe TrafficType) Source #

Defines the traffic patterns.

TrafficRoutingConfig

trafficRoutingConfig_canarySize :: Lens' TrafficRoutingConfig (Maybe CapacitySize) Source #

Batch size for the first step to turn on traffic on the new endpoint fleet. Value must be less than or equal to 50% of the variant's total instance count.

trafficRoutingConfig_linearStepSize :: Lens' TrafficRoutingConfig (Maybe CapacitySize) Source #

Batch size for each step to turn on traffic on the new endpoint fleet. Value must be 10-50% of the variant's total instance count.

trafficRoutingConfig_type :: Lens' TrafficRoutingConfig TrafficRoutingConfigType Source #

Traffic routing strategy type.

  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.
  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.

trafficRoutingConfig_waitIntervalInSeconds :: Lens' TrafficRoutingConfig Natural Source #

The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.

TrainingJob

trainingJob_algorithmSpecification :: Lens' TrainingJob (Maybe AlgorithmSpecification) Source #

Information about the algorithm used for training, and algorithm metadata.

trainingJob_autoMLJobArn :: Lens' TrainingJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the job.

trainingJob_billableTimeInSeconds :: Lens' TrainingJob (Maybe Natural) Source #

The billable time in seconds.

trainingJob_checkpointConfig :: Lens' TrainingJob (Maybe CheckpointConfig) Source #

Undocumented member.

trainingJob_creationTime :: Lens' TrainingJob (Maybe UTCTime) Source #

A timestamp that indicates when the training job was created.

trainingJob_debugHookConfig :: Lens' TrainingJob (Maybe DebugHookConfig) Source #

Undocumented member.

trainingJob_debugRuleConfigurations :: Lens' TrainingJob (Maybe [DebugRuleConfiguration]) Source #

Information about the debug rule configuration.

trainingJob_debugRuleEvaluationStatuses :: Lens' TrainingJob (Maybe [DebugRuleEvaluationStatus]) Source #

Information about the evaluation status of the rules for the training job.

trainingJob_enableInterContainerTrafficEncryption :: Lens' TrainingJob (Maybe Bool) Source #

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

trainingJob_enableManagedSpotTraining :: Lens' TrainingJob (Maybe Bool) Source #

When true, enables managed spot training using Amazon EC2 Spot instances to run training jobs instead of on-demand instances. For more information, see Managed Spot Training.

trainingJob_enableNetworkIsolation :: Lens' TrainingJob (Maybe Bool) Source #

If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

trainingJob_environment :: Lens' TrainingJob (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container.

trainingJob_experimentConfig :: Lens' TrainingJob (Maybe ExperimentConfig) Source #

Undocumented member.

trainingJob_failureReason :: Lens' TrainingJob (Maybe Text) Source #

If the training job failed, the reason it failed.

trainingJob_finalMetricDataList :: Lens' TrainingJob (Maybe [MetricData]) Source #

A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

trainingJob_hyperParameters :: Lens' TrainingJob (Maybe (HashMap Text Text)) Source #

Algorithm-specific parameters.

trainingJob_inputDataConfig :: Lens' TrainingJob (Maybe (NonEmpty Channel)) Source #

An array of Channel objects that describes each data input channel.

trainingJob_labelingJobArn :: Lens' TrainingJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the labeling job.

trainingJob_lastModifiedTime :: Lens' TrainingJob (Maybe UTCTime) Source #

A timestamp that indicates when the status of the training job was last modified.

trainingJob_modelArtifacts :: Lens' TrainingJob (Maybe ModelArtifacts) Source #

Information about the Amazon S3 location that is configured for storing model artifacts.

trainingJob_outputDataConfig :: Lens' TrainingJob (Maybe OutputDataConfig) Source #

The S3 path where model artifacts that you configured when creating the job are stored. SageMaker creates subfolders for model artifacts.

trainingJob_resourceConfig :: Lens' TrainingJob (Maybe ResourceConfig) Source #

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

trainingJob_retryStrategy :: Lens' TrainingJob (Maybe RetryStrategy) Source #

The number of times to retry the job when the job fails due to an InternalServerError.

trainingJob_roleArn :: Lens' TrainingJob (Maybe Text) Source #

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

trainingJob_secondaryStatus :: Lens' TrainingJob (Maybe SecondaryStatus) Source #

Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

SageMaker provides primary statuses and secondary statuses that apply to each of them:

InProgress
- Starting - Starting the training job.
  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
  • Training - Training is in progress.
  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
- Completed - The training job has completed.
Failed
- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
Stopped
- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
  • Stopped - The training job has stopped.
Stopping
- Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances
  • PreparingTrainingStack
  • DownloadingTrainingImage

trainingJob_secondaryStatusTransitions :: Lens' TrainingJob (Maybe [SecondaryStatusTransition]) Source #

A history of all of the secondary statuses that the training job has transitioned through.

trainingJob_stoppingCondition :: Lens' TrainingJob (Maybe StoppingCondition) Source #

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

trainingJob_tags :: Lens' TrainingJob (Maybe [Tag]) Source #

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

trainingJob_tensorBoardOutputConfig :: Lens' TrainingJob (Maybe TensorBoardOutputConfig) Source #

Undocumented member.

trainingJob_trainingEndTime :: Lens' TrainingJob (Maybe UTCTime) Source #

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

trainingJob_trainingJobArn :: Lens' TrainingJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the training job.

trainingJob_trainingJobName :: Lens' TrainingJob (Maybe Text) Source #

The name of the training job.

trainingJob_trainingJobStatus :: Lens' TrainingJob (Maybe TrainingJobStatus) Source #

The status of the training job.

Training job statuses are:

  • InProgress - The training is in progress.
  • Completed - The training job has completed.
  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.
  • Stopping - The training job is stopping.
  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

trainingJob_trainingStartTime :: Lens' TrainingJob (Maybe UTCTime) Source #

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

trainingJob_trainingTimeInSeconds :: Lens' TrainingJob (Maybe Natural) Source #

The training time in seconds.

trainingJob_tuningJobArn :: Lens' TrainingJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

trainingJob_vpcConfig :: Lens' TrainingJob (Maybe VpcConfig) Source #

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

TrainingJobDefinition

trainingJobDefinition_hyperParameters :: Lens' TrainingJobDefinition (Maybe (HashMap Text Text)) Source #

The hyperparameters used for the training job.

trainingJobDefinition_trainingInputMode :: Lens' TrainingJobDefinition TrainingInputMode Source #

Undocumented member.

trainingJobDefinition_inputDataConfig :: Lens' TrainingJobDefinition (NonEmpty Channel) Source #

An array of Channel objects, each of which specifies an input source.

trainingJobDefinition_outputDataConfig :: Lens' TrainingJobDefinition OutputDataConfig Source #

the path to the S3 bucket where you want to store model artifacts. SageMaker creates subfolders for the artifacts.

trainingJobDefinition_resourceConfig :: Lens' TrainingJobDefinition ResourceConfig Source #

The resources, including the ML compute instances and ML storage volumes, to use for model training.

trainingJobDefinition_stoppingCondition :: Lens' TrainingJobDefinition StoppingCondition Source #

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

TrainingJobStatusCounters

trainingJobStatusCounters_completed :: Lens' TrainingJobStatusCounters (Maybe Natural) Source #

The number of completed training jobs launched by the hyperparameter tuning job.

trainingJobStatusCounters_inProgress :: Lens' TrainingJobStatusCounters (Maybe Natural) Source #

The number of in-progress training jobs launched by a hyperparameter tuning job.

trainingJobStatusCounters_nonRetryableError :: Lens' TrainingJobStatusCounters (Maybe Natural) Source #

The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

trainingJobStatusCounters_retryableError :: Lens' TrainingJobStatusCounters (Maybe Natural) Source #

The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

trainingJobStatusCounters_stopped :: Lens' TrainingJobStatusCounters (Maybe Natural) Source #

The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

TrainingJobStepMetadata

trainingJobStepMetadata_arn :: Lens' TrainingJobStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the training job that was run by this step execution.

TrainingJobSummary

trainingJobSummary_lastModifiedTime :: Lens' TrainingJobSummary (Maybe UTCTime) Source #

Timestamp when the training job was last modified.

trainingJobSummary_trainingEndTime :: Lens' TrainingJobSummary (Maybe UTCTime) Source #

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

trainingJobSummary_warmPoolStatus :: Lens' TrainingJobSummary (Maybe WarmPoolStatus) Source #

The status of the warm pool associated with the training job.

trainingJobSummary_trainingJobName :: Lens' TrainingJobSummary Text Source #

The name of the training job that you want a summary for.

trainingJobSummary_trainingJobArn :: Lens' TrainingJobSummary Text Source #

The Amazon Resource Name (ARN) of the training job.

trainingJobSummary_creationTime :: Lens' TrainingJobSummary UTCTime Source #

A timestamp that shows when the training job was created.

trainingJobSummary_trainingJobStatus :: Lens' TrainingJobSummary TrainingJobStatus Source #

The status of the training job.

TrainingSpecification

trainingSpecification_metricDefinitions :: Lens' TrainingSpecification (Maybe [MetricDefinition]) Source #

A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

trainingSpecification_supportedHyperParameters :: Lens' TrainingSpecification (Maybe [HyperParameterSpecification]) Source #

A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

trainingSpecification_supportedTuningJobObjectiveMetrics :: Lens' TrainingSpecification (Maybe [HyperParameterTuningJobObjective]) Source #

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

trainingSpecification_supportsDistributedTraining :: Lens' TrainingSpecification (Maybe Bool) Source #

Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.

trainingSpecification_trainingImageDigest :: Lens' TrainingSpecification (Maybe Text) Source #

An MD5 hash of the training algorithm that identifies the Docker image used for training.

trainingSpecification_trainingImage :: Lens' TrainingSpecification Text Source #

The Amazon ECR registry path of the Docker image that contains the training algorithm.

trainingSpecification_supportedTrainingInstanceTypes :: Lens' TrainingSpecification [TrainingInstanceType] Source #

A list of the instance types that this algorithm can use for training.

trainingSpecification_trainingChannels :: Lens' TrainingSpecification (NonEmpty ChannelSpecification) Source #

A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

TransformDataSource

transformDataSource_s3DataSource :: Lens' TransformDataSource TransformS3DataSource Source #

The S3 location of the data source that is associated with a channel.

TransformInput

transformInput_compressionType :: Lens' TransformInput (Maybe CompressionType) Source #

If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

transformInput_contentType :: Lens' TransformInput (Maybe Text) Source #

The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

transformInput_splitType :: Lens' TransformInput (Maybe SplitType) Source #

The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats. Currently, the supported record formats are:

  • RecordIO
  • TFRecord

When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

For more information about RecordIO, see Create a Dataset Using RecordIO in the MXNet documentation. For more information about TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

transformInput_dataSource :: Lens' TransformInput TransformDataSource Source #

Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

TransformJob

transformJob_autoMLJobArn :: Lens' TransformJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AutoML job that created the transform job.

transformJob_batchStrategy :: Lens' TransformJob (Maybe BatchStrategy) Source #

Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

transformJob_creationTime :: Lens' TransformJob (Maybe UTCTime) Source #

A timestamp that shows when the transform Job was created.

transformJob_dataProcessing :: Lens' TransformJob (Maybe DataProcessing) Source #

Undocumented member.

transformJob_environment :: Lens' TransformJob (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

transformJob_experimentConfig :: Lens' TransformJob (Maybe ExperimentConfig) Source #

Undocumented member.

transformJob_failureReason :: Lens' TransformJob (Maybe Text) Source #

If the transform job failed, the reason it failed.

transformJob_labelingJobArn :: Lens' TransformJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the labeling job that created the transform job.

transformJob_maxConcurrentTransforms :: Lens' TransformJob (Maybe Natural) Source #

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

transformJob_maxPayloadInMB :: Lens' TransformJob (Maybe Natural) Source #

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB. For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, SageMaker built-in algorithms do not support HTTP chunked encoding.

transformJob_modelClientConfig :: Lens' TransformJob (Maybe ModelClientConfig) Source #

Undocumented member.

transformJob_modelName :: Lens' TransformJob (Maybe Text) Source #

The name of the model associated with the transform job.

transformJob_tags :: Lens' TransformJob (Maybe [Tag]) Source #

A list of tags associated with the transform job.

transformJob_transformEndTime :: Lens' TransformJob (Maybe UTCTime) Source #

Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

transformJob_transformInput :: Lens' TransformJob (Maybe TransformInput) Source #

Undocumented member.

transformJob_transformJobArn :: Lens' TransformJob (Maybe Text) Source #

The Amazon Resource Name (ARN) of the transform job.

transformJob_transformJobName :: Lens' TransformJob (Maybe Text) Source #

The name of the transform job.

transformJob_transformJobStatus :: Lens' TransformJob (Maybe TransformJobStatus) Source #

The status of the transform job.

Transform job statuses are:

  • InProgress - The job is in progress.
  • Completed - The job has completed.
  • Failed - The transform job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTransformJob call.
  • Stopping - The transform job is stopping.
  • Stopped - The transform job has stopped.

transformJob_transformOutput :: Lens' TransformJob (Maybe TransformOutput) Source #

Undocumented member.

transformJob_transformResources :: Lens' TransformJob (Maybe TransformResources) Source #

Undocumented member.

transformJob_transformStartTime :: Lens' TransformJob (Maybe UTCTime) Source #

Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

TransformJobDefinition

transformJobDefinition_batchStrategy :: Lens' TransformJobDefinition (Maybe BatchStrategy) Source #

A string that determines the number of records included in a single mini-batch.

SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

transformJobDefinition_environment :: Lens' TransformJobDefinition (Maybe (HashMap Text Text)) Source #

The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

transformJobDefinition_maxConcurrentTransforms :: Lens' TransformJobDefinition (Maybe Natural) Source #

The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

transformJobDefinition_maxPayloadInMB :: Lens' TransformJobDefinition (Maybe Natural) Source #

The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

transformJobDefinition_transformInput :: Lens' TransformJobDefinition TransformInput Source #

A description of the input source and the way the transform job consumes it.

transformJobDefinition_transformOutput :: Lens' TransformJobDefinition TransformOutput Source #

Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

transformJobDefinition_transformResources :: Lens' TransformJobDefinition TransformResources Source #

Identifies the ML compute instances for the transform job.

TransformJobStepMetadata

transformJobStepMetadata_arn :: Lens' TransformJobStepMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the transform job that was run by this step execution.

TransformJobSummary

transformJobSummary_failureReason :: Lens' TransformJobSummary (Maybe Text) Source #

If the transform job failed, the reason it failed.

transformJobSummary_lastModifiedTime :: Lens' TransformJobSummary (Maybe UTCTime) Source #

Indicates when the transform job was last modified.

transformJobSummary_transformEndTime :: Lens' TransformJobSummary (Maybe UTCTime) Source #

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.

transformJobSummary_transformJobName :: Lens' TransformJobSummary Text Source #

The name of the transform job.

transformJobSummary_transformJobArn :: Lens' TransformJobSummary Text Source #

The Amazon Resource Name (ARN) of the transform job.

transformJobSummary_creationTime :: Lens' TransformJobSummary UTCTime Source #

A timestamp that shows when the transform Job was created.

transformJobSummary_transformJobStatus :: Lens' TransformJobSummary TransformJobStatus Source #

The status of the transform job.

TransformOutput

transformOutput_accept :: Lens' TransformOutput (Maybe Text) Source #

The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

transformOutput_assembleWith :: Lens' TransformOutput (Maybe AssemblyType) Source #

Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

transformOutput_kmsKeyId :: Lens' TransformOutput (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

The KMS key policy must grant permission to the IAM role that you specify in your CreateModel request. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

transformOutput_s3OutputPath :: Lens' TransformOutput Text Source #

The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

TransformResources

transformResources_volumeKmsKeyId :: Lens' TransformResources (Maybe Text) Source #

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes.

For more information about local instance storage encryption, see SSD Instance Store Volumes.

The VolumeKmsKeyId can be any of the following formats:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
  • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Alias name: alias/ExampleAlias
  • Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias

transformResources_instanceType :: Lens' TransformResources TransformInstanceType Source #

The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.

transformResources_instanceCount :: Lens' TransformResources Natural Source #

The number of ML compute instances to use in the transform job. The default value is 1, and the maximum is 100. For distributed transform jobs, specify a value greater than 1.

TransformS3DataSource

transformS3DataSource_s3DataType :: Lens' TransformS3DataSource S3DataType Source #

If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

The following values are compatible: ManifestFile, S3Prefix

The following value is not compatible: AugmentedManifestFile

transformS3DataSource_s3Uri :: Lens' TransformS3DataSource Text Source #

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    [ {"prefix": "s3://customer_bucket/some/prefix/"},
    "relative/path/to/custdata-1",
    "relative/path/custdata-2",
    ...
    "relative/path/custdata-N"
    ]

    The preceding JSON matches the following S3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1
    s3://customer_bucket/some/prefix/relative/path/custdata-2
    ...
    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

Trial

trial_createdBy :: Lens' Trial (Maybe UserContext) Source #

Who created the trial.

trial_creationTime :: Lens' Trial (Maybe UTCTime) Source #

When the trial was created.

trial_displayName :: Lens' Trial (Maybe Text) Source #

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

trial_experimentName :: Lens' Trial (Maybe Text) Source #

The name of the experiment the trial is part of.

trial_lastModifiedBy :: Lens' Trial (Maybe UserContext) Source #

Undocumented member.

trial_lastModifiedTime :: Lens' Trial (Maybe UTCTime) Source #

Who last modified the trial.

trial_metadataProperties :: Lens' Trial (Maybe MetadataProperties) Source #

Undocumented member.

trial_source :: Lens' Trial (Maybe TrialSource) Source #

Undocumented member.

trial_tags :: Lens' Trial (Maybe [Tag]) Source #

The list of tags that are associated with the trial. You can use Search API to search on the tags.

trial_trialArn :: Lens' Trial (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

trial_trialComponentSummaries :: Lens' Trial (Maybe [TrialComponentSimpleSummary]) Source #

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

trial_trialName :: Lens' Trial (Maybe Text) Source #

The name of the trial.

TrialComponent

trialComponent_createdBy :: Lens' TrialComponent (Maybe UserContext) Source #

Who created the trial component.

trialComponent_creationTime :: Lens' TrialComponent (Maybe UTCTime) Source #

When the component was created.

trialComponent_displayName :: Lens' TrialComponent (Maybe Text) Source #

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

trialComponent_endTime :: Lens' TrialComponent (Maybe UTCTime) Source #

When the component ended.

trialComponent_inputArtifacts :: Lens' TrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

The input artifacts of the component.

trialComponent_lastModifiedBy :: Lens' TrialComponent (Maybe UserContext) Source #

Undocumented member.

trialComponent_lastModifiedTime :: Lens' TrialComponent (Maybe UTCTime) Source #

When the component was last modified.

trialComponent_lineageGroupArn :: Lens' TrialComponent (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage group resource.

trialComponent_metadataProperties :: Lens' TrialComponent (Maybe MetadataProperties) Source #

Undocumented member.

trialComponent_metrics :: Lens' TrialComponent (Maybe [TrialComponentMetricSummary]) Source #

The metrics for the component.

trialComponent_outputArtifacts :: Lens' TrialComponent (Maybe (HashMap Text TrialComponentArtifact)) Source #

The output artifacts of the component.

trialComponent_parameters :: Lens' TrialComponent (Maybe (HashMap Text TrialComponentParameterValue)) Source #

The hyperparameters of the component.

trialComponent_parents :: Lens' TrialComponent (Maybe [Parent]) Source #

An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.

trialComponent_runName :: Lens' TrialComponent (Maybe Text) Source #

The name of the experiment run.

trialComponent_source :: Lens' TrialComponent (Maybe TrialComponentSource) Source #

The Amazon Resource Name (ARN) and job type of the source of the component.

trialComponent_sourceDetail :: Lens' TrialComponent (Maybe TrialComponentSourceDetail) Source #

Details of the source of the component.

trialComponent_startTime :: Lens' TrialComponent (Maybe UTCTime) Source #

When the component started.

trialComponent_status :: Lens' TrialComponent (Maybe TrialComponentStatus) Source #

Undocumented member.

trialComponent_tags :: Lens' TrialComponent (Maybe [Tag]) Source #

The list of tags that are associated with the component. You can use Search API to search on the tags.

trialComponent_trialComponentArn :: Lens' TrialComponent (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

trialComponent_trialComponentName :: Lens' TrialComponent (Maybe Text) Source #

The name of the trial component.

TrialComponentArtifact

trialComponentArtifact_mediaType :: Lens' TrialComponentArtifact (Maybe Text) Source #

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

trialComponentArtifact_value :: Lens' TrialComponentArtifact Text Source #

The location of the artifact.

TrialComponentMetricSummary

trialComponentMetricSummary_avg :: Lens' TrialComponentMetricSummary (Maybe Double) Source #

The average value of the metric.

trialComponentMetricSummary_count :: Lens' TrialComponentMetricSummary (Maybe Int) Source #

The number of samples used to generate the metric.

trialComponentMetricSummary_last :: Lens' TrialComponentMetricSummary (Maybe Double) Source #

The most recent value of the metric.

trialComponentMetricSummary_max :: Lens' TrialComponentMetricSummary (Maybe Double) Source #

The maximum value of the metric.

trialComponentMetricSummary_metricName :: Lens' TrialComponentMetricSummary (Maybe Text) Source #

The name of the metric.

trialComponentMetricSummary_min :: Lens' TrialComponentMetricSummary (Maybe Double) Source #

The minimum value of the metric.

trialComponentMetricSummary_sourceArn :: Lens' TrialComponentMetricSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source.

trialComponentMetricSummary_stdDev :: Lens' TrialComponentMetricSummary (Maybe Double) Source #

The standard deviation of the metric.

trialComponentMetricSummary_timeStamp :: Lens' TrialComponentMetricSummary (Maybe UTCTime) Source #

When the metric was last updated.

TrialComponentParameterValue

trialComponentParameterValue_numberValue :: Lens' TrialComponentParameterValue (Maybe Double) Source #

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.

trialComponentParameterValue_stringValue :: Lens' TrialComponentParameterValue (Maybe Text) Source #

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.

TrialComponentSimpleSummary

trialComponentSimpleSummary_createdBy :: Lens' TrialComponentSimpleSummary (Maybe UserContext) Source #

Undocumented member.

trialComponentSimpleSummary_creationTime :: Lens' TrialComponentSimpleSummary (Maybe UTCTime) Source #

When the component was created.

trialComponentSimpleSummary_trialComponentArn :: Lens' TrialComponentSimpleSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

trialComponentSimpleSummary_trialComponentName :: Lens' TrialComponentSimpleSummary (Maybe Text) Source #

The name of the trial component.

trialComponentSimpleSummary_trialComponentSource :: Lens' TrialComponentSimpleSummary (Maybe TrialComponentSource) Source #

Undocumented member.

TrialComponentSource

trialComponentSource_sourceType :: Lens' TrialComponentSource (Maybe Text) Source #

The source job type.

trialComponentSource_sourceArn :: Lens' TrialComponentSource Text Source #

The source Amazon Resource Name (ARN).

TrialComponentSourceDetail

trialComponentSourceDetail_processingJob :: Lens' TrialComponentSourceDetail (Maybe ProcessingJob) Source #

Information about a processing job that's the source of a trial component.

trialComponentSourceDetail_sourceArn :: Lens' TrialComponentSourceDetail (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source.

trialComponentSourceDetail_trainingJob :: Lens' TrialComponentSourceDetail (Maybe TrainingJob) Source #

Information about a training job that's the source of a trial component.

trialComponentSourceDetail_transformJob :: Lens' TrialComponentSourceDetail (Maybe TransformJob) Source #

Information about a transform job that's the source of a trial component.

TrialComponentStatus

trialComponentStatus_message :: Lens' TrialComponentStatus (Maybe Text) Source #

If the component failed, a message describing why.

trialComponentStatus_primaryStatus :: Lens' TrialComponentStatus (Maybe TrialComponentPrimaryStatus) Source #

The status of the trial component.

TrialComponentSummary

trialComponentSummary_createdBy :: Lens' TrialComponentSummary (Maybe UserContext) Source #

Who created the trial component.

trialComponentSummary_creationTime :: Lens' TrialComponentSummary (Maybe UTCTime) Source #

When the component was created.

trialComponentSummary_displayName :: Lens' TrialComponentSummary (Maybe Text) Source #

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

trialComponentSummary_endTime :: Lens' TrialComponentSummary (Maybe UTCTime) Source #

When the component ended.

trialComponentSummary_lastModifiedBy :: Lens' TrialComponentSummary (Maybe UserContext) Source #

Who last modified the component.

trialComponentSummary_lastModifiedTime :: Lens' TrialComponentSummary (Maybe UTCTime) Source #

When the component was last modified.

trialComponentSummary_startTime :: Lens' TrialComponentSummary (Maybe UTCTime) Source #

When the component started.

trialComponentSummary_status :: Lens' TrialComponentSummary (Maybe TrialComponentStatus) Source #

The status of the component. States include:

  • InProgress
  • Completed
  • Failed

trialComponentSummary_trialComponentArn :: Lens' TrialComponentSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial component.

trialComponentSummary_trialComponentName :: Lens' TrialComponentSummary (Maybe Text) Source #

The name of the trial component.

trialComponentSummary_trialComponentSource :: Lens' TrialComponentSummary (Maybe TrialComponentSource) Source #

Undocumented member.

TrialSource

trialSource_sourceType :: Lens' TrialSource (Maybe Text) Source #

The source job type.

trialSource_sourceArn :: Lens' TrialSource Text Source #

The Amazon Resource Name (ARN) of the source.

TrialSummary

trialSummary_creationTime :: Lens' TrialSummary (Maybe UTCTime) Source #

When the trial was created.

trialSummary_displayName :: Lens' TrialSummary (Maybe Text) Source #

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

trialSummary_lastModifiedTime :: Lens' TrialSummary (Maybe UTCTime) Source #

When the trial was last modified.

trialSummary_trialArn :: Lens' TrialSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the trial.

trialSummary_trialName :: Lens' TrialSummary (Maybe Text) Source #

The name of the trial.

trialSummary_trialSource :: Lens' TrialSummary (Maybe TrialSource) Source #

Undocumented member.

TuningJobCompletionCriteria

tuningJobCompletionCriteria_targetObjectiveMetricValue :: Lens' TuningJobCompletionCriteria Double Source #

The value of the objective metric.

TuningJobStepMetaData

tuningJobStepMetaData_arn :: Lens' TuningJobStepMetaData (Maybe Text) Source #

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

USD

usd_cents :: Lens' USD (Maybe Natural) Source #

The fractional portion, in cents, of the amount.

usd_dollars :: Lens' USD (Maybe Natural) Source #

The whole number of dollars in the amount.

usd_tenthFractionsOfACent :: Lens' USD (Maybe Natural) Source #

Fractions of a cent, in tenths.

UiConfig

uiConfig_humanTaskUiArn :: Lens' UiConfig (Maybe Text) Source #

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for named entity recognition, 3D point cloud and video frame labeling jobs. Use your labeling job task type to select one of the following ARNs and use it with this parameter when you create a labeling job. Replace aws-region with the Amazon Web Services Region you are creating your labeling job in. For example, replace aws-region with us-west-1 if you create a labeling job in US West (N. California).

Named Entity Recognition

Use the following HumanTaskUiArn for named entity recognition labeling jobs:

arn:aws:sagemaker:aws-region:394669845002:human-task-ui/NamedEntityRecognition

3D Point Cloud HumanTaskUiArns

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

Video Frame HumanTaskUiArns

Use this HumanTaskUiArn for video frame object detection and video frame object detection adjustment labeling jobs.

  • arn:aws:sagemaker:region:394669845002:human-task-ui/VideoObjectDetection

Use this HumanTaskUiArn for video frame object tracking and video frame object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/VideoObjectTracking

uiConfig_uiTemplateS3Uri :: Lens' UiConfig (Maybe Text) Source #

The Amazon S3 bucket location of the UI template, or worker task template. This is the template used to render the worker UI and tools for labeling job tasks. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

UiTemplate

uiTemplate_content :: Lens' UiTemplate Text Source #

The content of the Liquid template for the worker user interface.

UiTemplateInfo

uiTemplateInfo_contentSha256 :: Lens' UiTemplateInfo (Maybe Text) Source #

The SHA-256 digest of the contents of the template.

uiTemplateInfo_url :: Lens' UiTemplateInfo (Maybe Text) Source #

The URL for the user interface template.

UserContext

userContext_domainId :: Lens' UserContext (Maybe Text) Source #

The domain associated with the user.

userContext_userProfileArn :: Lens' UserContext (Maybe Text) Source #

The Amazon Resource Name (ARN) of the user's profile.

userContext_userProfileName :: Lens' UserContext (Maybe Text) Source #

The name of the user's profile.

UserProfileDetails

userProfileDetails_creationTime :: Lens' UserProfileDetails (Maybe UTCTime) Source #

The creation time.

userProfileDetails_domainId :: Lens' UserProfileDetails (Maybe Text) Source #

The domain ID.

userProfileDetails_lastModifiedTime :: Lens' UserProfileDetails (Maybe UTCTime) Source #

The last modified time.

userProfileDetails_status :: Lens' UserProfileDetails (Maybe UserProfileStatus) Source #

The status.

userProfileDetails_userProfileName :: Lens' UserProfileDetails (Maybe Text) Source #

The user profile name.

UserSettings

userSettings_canvasAppSettings :: Lens' UserSettings (Maybe CanvasAppSettings) Source #

The Canvas app settings.

userSettings_executionRole :: Lens' UserSettings (Maybe Text) Source #

The execution role for the user.

userSettings_jupyterServerAppSettings :: Lens' UserSettings (Maybe JupyterServerAppSettings) Source #

The Jupyter server's app settings.

userSettings_kernelGatewayAppSettings :: Lens' UserSettings (Maybe KernelGatewayAppSettings) Source #

The kernel gateway app settings.

userSettings_rSessionAppSettings :: Lens' UserSettings (Maybe RSessionAppSettings) Source #

A collection of settings that configure the RSessionGateway app.

userSettings_rStudioServerProAppSettings :: Lens' UserSettings (Maybe RStudioServerProAppSettings) Source #

A collection of settings that configure user interaction with the RStudioServerPro app.

userSettings_securityGroups :: Lens' UserSettings (Maybe [Text]) Source #

The security groups for the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Optional when the CreateDomain.AppNetworkAccessType parameter is set to PublicInternetOnly.

Required when the CreateDomain.AppNetworkAccessType parameter is set to VpcOnly.

Amazon SageMaker adds a security group to allow NFS traffic from SageMaker Studio. Therefore, the number of security groups that you can specify is one less than the maximum number shown.

userSettings_sharingSettings :: Lens' UserSettings (Maybe SharingSettings) Source #

Specifies options for sharing SageMaker Studio notebooks.

userSettings_tensorBoardAppSettings :: Lens' UserSettings (Maybe TensorBoardAppSettings) Source #

The TensorBoard app settings.

VariantProperty

variantProperty_variantPropertyType :: Lens' VariantProperty VariantPropertyType Source #

The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the ProductionVariant$InitialInstanceCount values in the CreateEndpointConfigInput$ProductionVariants.
  • DesiredWeight: Overrides the existing variant weights using the ProductionVariant$InitialVariantWeight values in the CreateEndpointConfigInput$ProductionVariants.
  • DataCaptureConfig: (Not currently supported.)

Vertex

vertex_arn :: Lens' Vertex (Maybe Text) Source #

The Amazon Resource Name (ARN) of the lineage entity resource.

vertex_lineageType :: Lens' Vertex (Maybe LineageType) Source #

The type of resource of the lineage entity.

vertex_type :: Lens' Vertex (Maybe Text) Source #

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...

VpcConfig

vpcConfig_securityGroupIds :: Lens' VpcConfig (NonEmpty Text) Source #

The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

vpcConfig_subnets :: Lens' VpcConfig (NonEmpty Text) Source #

The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.

WarmPoolStatus

warmPoolStatus_resourceRetainedBillableTimeInSeconds :: Lens' WarmPoolStatus (Maybe Natural) Source #

The billable time in seconds used by the warm pool. Billable time refers to the absolute wall-clock time.

Multiply ResourceRetainedBillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker bills you if you run warm pool training. The formula is as follows: ResourceRetainedBillableTimeInSeconds * InstanceCount.

warmPoolStatus_reusedByJob :: Lens' WarmPoolStatus (Maybe Text) Source #

The name of the matching training job that reused the warm pool.

warmPoolStatus_status :: Lens' WarmPoolStatus WarmPoolResourceStatus Source #

The status of the warm pool.

  • InUse: The warm pool is in use for the training job.
  • Available: The warm pool is available to reuse for a matching training job.
  • Reused: The warm pool moved to a matching training job for reuse.
  • Terminated: The warm pool is no longer available. Warm pools are unavailable if they are terminated by a user, terminated for a patch update, or terminated for exceeding the specified KeepAlivePeriodInSeconds.

Workforce

workforce_cognitoConfig :: Lens' Workforce (Maybe CognitoConfig) Source #

The configuration of an Amazon Cognito workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

workforce_createDate :: Lens' Workforce (Maybe UTCTime) Source #

The date that the workforce is created.

workforce_failureReason :: Lens' Workforce (Maybe Text) Source #

The reason your workforce failed.

workforce_lastUpdatedDate :: Lens' Workforce (Maybe UTCTime) Source #

The most recent date that was used to successfully add one or more IP address ranges (CIDRs) to a private workforce's allow list.

workforce_oidcConfig :: Lens' Workforce (Maybe OidcConfigForResponse) Source #

The configuration of an OIDC Identity Provider (IdP) private workforce.

workforce_sourceIpConfig :: Lens' Workforce (Maybe SourceIpConfig) Source #

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list. By default, a workforce isn't restricted to specific IP addresses.

workforce_status :: Lens' Workforce (Maybe WorkforceStatus) Source #

The status of your workforce.

workforce_subDomain :: Lens' Workforce (Maybe Text) Source #

The subdomain for your OIDC Identity Provider.

workforce_workforceVpcConfig :: Lens' Workforce (Maybe WorkforceVpcConfigResponse) Source #

The configuration of a VPC workforce.

workforce_workforceName :: Lens' Workforce Text Source #

The name of the private workforce.

workforce_workforceArn :: Lens' Workforce Text Source #

The Amazon Resource Name (ARN) of the private workforce.

WorkforceVpcConfigRequest

workforceVpcConfigRequest_securityGroupIds :: Lens' WorkforceVpcConfigRequest (Maybe (NonEmpty Text)) Source #

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

workforceVpcConfigRequest_subnets :: Lens' WorkforceVpcConfigRequest (Maybe (NonEmpty Text)) Source #

The ID of the subnets in the VPC that you want to connect.

workforceVpcConfigRequest_vpcId :: Lens' WorkforceVpcConfigRequest (Maybe Text) Source #

The ID of the VPC that the workforce uses for communication.

WorkforceVpcConfigResponse

workforceVpcConfigResponse_vpcEndpointId :: Lens' WorkforceVpcConfigResponse (Maybe Text) Source #

The IDs for the VPC service endpoints of your VPC workforce when it is created and updated.

workforceVpcConfigResponse_vpcId :: Lens' WorkforceVpcConfigResponse Text Source #

The ID of the VPC that the workforce uses for communication.

workforceVpcConfigResponse_securityGroupIds :: Lens' WorkforceVpcConfigResponse (NonEmpty Text) Source #

The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

workforceVpcConfigResponse_subnets :: Lens' WorkforceVpcConfigResponse (NonEmpty Text) Source #

The ID of the subnets in the VPC that you want to connect.

Workteam

workteam_createDate :: Lens' Workteam (Maybe UTCTime) Source #

The date and time that the work team was created (timestamp).

workteam_lastUpdatedDate :: Lens' Workteam (Maybe UTCTime) Source #

The date and time that the work team was last updated (timestamp).

workteam_notificationConfiguration :: Lens' Workteam (Maybe NotificationConfiguration) Source #

Configures SNS notifications of available or expiring work items for work teams.

workteam_productListingIds :: Lens' Workteam (Maybe [Text]) Source #

The Amazon Marketplace identifier for a vendor's work team.

workteam_subDomain :: Lens' Workteam (Maybe Text) Source #

The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

workteam_workforceArn :: Lens' Workteam (Maybe Text) Source #

The Amazon Resource Name (ARN) of the workforce.

workteam_workteamName :: Lens' Workteam Text Source #

The name of the work team.

workteam_memberDefinitions :: Lens' Workteam (NonEmpty MemberDefinition) Source #

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition.

workteam_workteamArn :: Lens' Workteam Text Source #

The Amazon Resource Name (ARN) that identifies the work team.

workteam_description :: Lens' Workteam Text Source #

A description of the work team.