Skip to content

Commit

Permalink
Periodic update - 5/08/19
Browse files Browse the repository at this point in the history
  • Loading branch information
eslesar-aws committed May 8, 2019
1 parent 41ba9e1 commit cec61ab
Show file tree
Hide file tree
Showing 127 changed files with 1,581 additions and 1,090 deletions.
8 changes: 8 additions & 0 deletions doc_source/API_AnnotationConsolidationConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ For the built\-in bounding box, image classification, semantic segmentation, and
`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`
+ *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`
Expand All @@ -29,6 +31,8 @@ For the built\-in bounding box, image classification, semantic segmentation, and
`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`
+ *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`
Expand All @@ -40,6 +44,8 @@ For the built\-in bounding box, image classification, semantic segmentation, and
`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`
+ *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`
Expand All @@ -51,6 +57,8 @@ For the built\-in bounding box, image classification, semantic segmentation, and
`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`
For more information, see [Annotation Consolidation](http://docs.aws.amazon.com/sagemaker/latest/dg/sms-annotation-consolidation.html)\.
Type: String
Length Constraints: Maximum length of 2048\.
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_CompilationJobSummary.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Required: No
**CompilationTargetDevice** <a name="SageMaker-Type-CompilationJobSummary-CompilationTargetDevice"></a>
The type of device that the model will run on after compilation has completed\.
Type: String
Valid Values:` lambda | ml_m4 | ml_m5 | ml_c4 | ml_c5 | ml_p2 | ml_p3 | jetson_tx1 | jetson_tx2 | rasp3b | deeplens | rk3399 | rk3288`
Valid Values:` lambda | ml_m4 | ml_m5 | ml_c4 | ml_c5 | ml_p2 | ml_p3 | jetson_tx1 | jetson_tx2 | jetson_nano | rasp3b | deeplens | rk3399 | rk3288`
Required: Yes

**CreationTime** <a name="SageMaker-Type-CompilationJobSummary-CreationTime"></a>
Expand Down
5 changes: 3 additions & 2 deletions doc_source/API_ContainerDefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,16 @@ Pattern: `[\S]+`
Required: No

**ModelDataUrl** <a name="SageMaker-Type-ContainerDefinition-ModelDataUrl"></a>
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 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 Amazon SageMaker built\-in algorithms, but not if you use your own algorithms\. For more information on built\-in algorithms, see [Common Parameters](http://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html)\.
If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide\. AWS STS is activated in your IAM user account by default\. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region\. For more information, see [Activating and Deactivating AWS STS in an AWS Region](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html) in the *AWS Identity and Access Management User Guide*\.
If you use a built\-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in `ModelDataUrl`\.
Type: String
Length Constraints: Maximum length of 1024\.
Pattern: `^(https|s3)://([^/]+)/?(.*)$`
Required: No

**ModelPackageName** <a name="SageMaker-Type-ContainerDefinition-ModelPackageName"></a>
The name of the model package to use to create the model\.
The name or Amazon Resource Name \(ARN\) of the model package to use to create the model\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 170\.
Pattern: `(arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:[a-z\-]*\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?<!-)$`
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_CreateCompilationJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Type: [OutputConfig](API_OutputConfig.md) object
Required: Yes

** [RoleArn](#API_CreateCompilationJob_RequestSyntax) ** <a name="SageMaker-CreateCompilationJob-request-RoleArn"></a>
The Amazon Resource Name \(ARN\) of an IIAMAM role that enables Amazon SageMaker to perform tasks on your behalf\.
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
Expand Down
3 changes: 2 additions & 1 deletion doc_source/API_CreateEndpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
Creates an endpoint using the endpoint configuration specified in the request\. Amazon SageMaker uses the endpoint to provision resources and deploy models\. You create the endpoint configuration with the [CreateEndpointConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateEndpointConfig.html) API\.

**Note**
Use this API only for hosting models using Amazon SageMaker hosting services\.
Use this API only for hosting models using Amazon SageMaker hosting services\.
You must not delete an `EndpointConfig` in use by an endpoint that is live or while the `UpdateEndpoint` or `CreateEndpoint` operations are being performed on the endpoint\. To update an endpoint, you must create a new `EndpointConfig`\.

The endpoint name must be unique within an AWS Region in your AWS account\.

Expand Down
4 changes: 2 additions & 2 deletions doc_source/API_CreateEndpointConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,13 @@ Pattern: `.*`
Required: No

** [ProductionVariants](#API_CreateEndpointConfig_RequestSyntax) ** <a name="SageMaker-CreateEndpointConfig-request-ProductionVariants"></a>
An array of `ProductionVariant` objects, one for each model that you want to host at this endpoint\.
An list of `ProductionVariant` objects, one for each model that you want to host at this endpoint\.
Type: Array of [ProductionVariant](API_ProductionVariant.md) objects
Array Members: Minimum number of 1 item\.
Required: Yes

** [Tags](#API_CreateEndpointConfig_RequestSyntax) ** <a name="SageMaker-CreateEndpointConfig-request-Tags"></a>
An array of key\-value pairs\. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the *AWS Billing and Cost Management User Guide*\.
A list of key\-value pairs\. For more information, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what) in the * AWS Billing and Cost Management User Guide*\.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items\. Maximum number of 50 items\.
Required: No
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_CreateHyperParameterTuningJob.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Required: No
** [TrainingJobDefinition](#API_CreateHyperParameterTuningJob_RequestSyntax) ** <a name="SageMaker-CreateHyperParameterTuningJob-request-TrainingJobDefinition"></a>
The [HyperParameterTrainingJobDefinition](API_HyperParameterTrainingJobDefinition.md) 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\.
Type: [HyperParameterTrainingJobDefinition](API_HyperParameterTrainingJobDefinition.md) object
Required: Yes
Required: No

** [WarmStartConfig](#API_CreateHyperParameterTuningJob_RequestSyntax) ** <a name="SageMaker-CreateHyperParameterTuningJob-request-WarmStartConfig"></a>
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\.
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_CreateModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Array Members: Minimum number of 0 items\. Maximum number of 50 items\.
Required: No

** [VpcConfig](#API_CreateModel_RequestSyntax) ** <a name="SageMaker-CreateModel-request-VpcConfig"></a>
A [VpcConfig](API_VpcConfig.md) object that specifies the VPC that you want your model to connect to\. Control access to and from your model container by configuring the VPC\. `VpcConfig` is used in hosting services and in batch transform\. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html)\.
A [VpcConfig](https://docs.aws.amazon.com/sagemaker/latest/dg/API_VpcConfig.html) object that specifies the VPC that you want your model to connect to\. Control access to and from your model container by configuring the VPC\. `VpcConfig` is used in hosting services and in batch transform\. For more information, see [Protect Endpoints by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html) and [Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud](https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html)\.
Type: [VpcConfig](API_VpcConfig.md) object
Required: No

Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_CreateNotebookInstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Valid Values:` ml.t2.medium | ml.t2.large | ml.t2.xlarge | ml.t2.2xlarge | ml.t3
Required: Yes

** [KmsKeyId](#API_CreateNotebookInstance_RequestSyntax) ** <a name="SageMaker-CreateNotebookInstance-request-KmsKeyId"></a>
If you provide a AWS KMS key ID, Amazon SageMaker uses it to encrypt data at rest on the ML storage volume that is attached to your notebook instance\. The KMS key you provide must be enabled\. For information, see [Enabling and Disabling Keys](http://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in the *AWS Key Management Service Developer Guide*\.
The Amazon Resource Name \(ARN\) of a AWS Key Management Service key that Amazon 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](http://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html) in the *AWS Key Management Service Developer Guide*\.
Type: String
Length Constraints: Maximum length of 2048\.
Pattern: `.*`
Expand Down
8 changes: 8 additions & 0 deletions doc_source/API_CreateWorkteam.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ You cannot create more than 25 work teams in an account and region\.
}
}
],
"[NotificationConfiguration](#SageMaker-CreateWorkteam-request-NotificationConfiguration)": {
"[NotificationTopicArn](API_NotificationConfiguration.md#SageMaker-Type-NotificationConfiguration-NotificationTopicArn)": "string"
},
"[Tags](#SageMaker-CreateWorkteam-request-Tags)": [
{
"[Key](API_Tag.md#SageMaker-Type-Tag-Key)": "string",
Expand Down Expand Up @@ -48,6 +51,11 @@ Type: Array of [MemberDefinition](API_MemberDefinition.md) objects
Array Members: Minimum number of 1 item\. Maximum number of 10 items\.
Required: Yes

** [NotificationConfiguration](#API_CreateWorkteam_RequestSyntax) ** <a name="SageMaker-CreateWorkteam-request-NotificationConfiguration"></a>
Configures notification of workers regarding available or expiring work items\.
Type: [NotificationConfiguration](API_NotificationConfiguration.md) object
Required: No

** [Tags](#API_CreateWorkteam_RequestSyntax) ** <a name="SageMaker-CreateWorkteam-request-Tags"></a>
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items\. Maximum number of 50 items\.
Expand Down
2 changes: 1 addition & 1 deletion doc_source/API_DataSource.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Describes the location of the channel data\.
**S3DataSource** <a name="SageMaker-Type-DataSource-S3DataSource"></a>
The S3 location of the data source that is associated with a channel\.
Type: [S3DataSource](API_S3DataSource.md) object
Required: Yes
Required: No

## See Also<a name="API_DataSource_SeeAlso"></a>

Expand Down
3 changes: 3 additions & 0 deletions doc_source/API_DescribeWorkteam.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ Required: Yes
}
}
],
"[NotificationConfiguration](API_Workteam.md#SageMaker-Type-Workteam-NotificationConfiguration)": {
"[NotificationTopicArn](API_NotificationConfiguration.md#SageMaker-Type-NotificationConfiguration-NotificationTopicArn)": "string"
},
"[ProductListingIds](API_Workteam.md#SageMaker-Type-Workteam-ProductListingIds)": [ "string" ],
"[SubDomain](API_Workteam.md#SageMaker-Type-Workteam-SubDomain)": "string",
"[WorkteamArn](API_Workteam.md#SageMaker-Type-Workteam-WorkteamArn)": "string",
Expand Down
5 changes: 5 additions & 0 deletions doc_source/API_HumanTaskConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ For the built\-in bounding box, image classification, semantic segmentation, and
+ `arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass`
+ `arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation`
+ `arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass`
**Asia Pacific \(Sydney \(ap\-southeast\-1\):**
+ `arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox`
+ `arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass`
+ `arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation`
+ `arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass`
Type: String
Length Constraints: Maximum length of 2048\.
Pattern: `arn:aws[a-z\-]*:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Expand Down
4 changes: 2 additions & 2 deletions doc_source/API_HyperParameterTuningJobConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ Configures a hyperparameter tuning job\.
**HyperParameterTuningJobObjective** <a name="SageMaker-Type-HyperParameterTuningJobConfig-HyperParameterTuningJobObjective"></a>
The [HyperParameterTuningJobObjective](API_HyperParameterTuningJobObjective.md) object that specifies the objective metric for this tuning job\.
Type: [HyperParameterTuningJobObjective](API_HyperParameterTuningJobObjective.md) object
Required: Yes
Required: No

**ParameterRanges** <a name="SageMaker-Type-HyperParameterTuningJobConfig-ParameterRanges"></a>
The [ParameterRanges](API_ParameterRanges.md) object that specifies the ranges of hyperparameters that this tuning job searches\.
Type: [ParameterRanges](API_ParameterRanges.md) object
Required: Yes
Required: No

**ResourceLimits** <a name="SageMaker-Type-HyperParameterTuningJobConfig-ResourceLimits"></a>
The [ResourceLimits](API_ResourceLimits.md) object that specifies the maximum number of training jobs and parallel training jobs for this tuning job\.
Expand Down
6 changes: 6 additions & 0 deletions doc_source/API_LabelingJobForWorkteamSummary.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ The name of the labeling job that the work team is assigned to\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9](-*[a-zA-Z0-9])*`
Required: No

**NumberOfHumanWorkersPerDataObject** <a name="SageMaker-Type-LabelingJobForWorkteamSummary-NumberOfHumanWorkersPerDataObject"></a>
The configured number of workers per data object\.
Type: Integer
Valid Range: Minimum value of 1\. Maximum value of 9\.
Required: No

**WorkRequesterAccountId** <a name="SageMaker-Type-LabelingJobForWorkteamSummary-WorkRequesterAccountId"></a>
Expand Down
1 change: 1 addition & 0 deletions doc_source/API_ListLabelingJobsForWorkteam.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ Required: Yes
"[Total](API_LabelCountersForWorkteam.md#SageMaker-Type-LabelCountersForWorkteam-Total)": number
},
"[LabelingJobName](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-LabelingJobName)": "string",
"[NumberOfHumanWorkersPerDataObject](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-NumberOfHumanWorkersPerDataObject)": number,
"[WorkRequesterAccountId](API_LabelingJobForWorkteamSummary.md#SageMaker-Type-LabelingJobForWorkteamSummary-WorkRequesterAccountId)": "string"
}
],
Expand Down
3 changes: 3 additions & 0 deletions doc_source/API_ListWorkteams.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ Required: No
}
}
],
"[NotificationConfiguration](API_Workteam.md#SageMaker-Type-Workteam-NotificationConfiguration)": {
"[NotificationTopicArn](API_NotificationConfiguration.md#SageMaker-Type-NotificationConfiguration-NotificationTopicArn)": "string"
},
"[ProductListingIds](API_Workteam.md#SageMaker-Type-Workteam-ProductListingIds)": [ "string" ],
"[SubDomain](API_Workteam.md#SageMaker-Type-Workteam-SubDomain)": "string",
"[WorkteamArn](API_Workteam.md#SageMaker-Type-Workteam-WorkteamArn)": "string",
Expand Down
1 change: 1 addition & 0 deletions doc_source/API_MetricDefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Required: Yes
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](https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html)\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 500\.
Pattern: `.+`
Required: Yes

## See Also<a name="API_MetricDefinition_SeeAlso"></a>
Expand Down
20 changes: 20 additions & 0 deletions doc_source/API_NotificationConfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# NotificationConfiguration<a name="API_NotificationConfiguration"></a>

Configures SNS notifications of available or expiring work items for work teams\.

## Contents<a name="API_NotificationConfiguration_Contents"></a>

**NotificationTopicArn** <a name="SageMaker-Type-NotificationConfiguration-NotificationTopicArn"></a>
The ARN for the SNS topic to which notifications should be published\.
Type: String
Pattern: `arn:aws[a-z\-]*:sns:[a-z0-9\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*`
Required: No

## See Also<a name="API_NotificationConfiguration_SeeAlso"></a>

For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/NotificationConfiguration)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/sagemaker-2017-07-24/NotificationConfiguration)
+ [AWS SDK for Go \- Pilot](https://docs.aws.amazon.com/goto/SdkForGoPilot/sagemaker-2017-07-24/NotificationConfiguration)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/sagemaker-2017-07-24/NotificationConfiguration)
+ [AWS SDK for Ruby V2](https://docs.aws.amazon.com/goto/SdkForRubyV2/sagemaker-2017-07-24/NotificationConfiguration)
2 changes: 1 addition & 1 deletion doc_source/API_OutputConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Required: Yes
**TargetDevice** <a name="SageMaker-Type-OutputConfig-TargetDevice"></a>
Identifies the device that you want to run your model on after it has been compiled\. For example: ml\_c5\.
Type: String
Valid Values:` lambda | ml_m4 | ml_m5 | ml_c4 | ml_c5 | ml_p2 | ml_p3 | jetson_tx1 | jetson_tx2 | rasp3b | deeplens | rk3399 | rk3288`
Valid Values:` lambda | ml_m4 | ml_m5 | ml_c4 | ml_c5 | ml_p2 | ml_p3 | jetson_tx1 | jetson_tx2 | jetson_nano | rasp3b | deeplens | rk3399 | rk3288`
Required: Yes

## See Also<a name="API_OutputConfig_SeeAlso"></a>
Expand Down
Loading

0 comments on commit cec61ab

Please sign in to comment.