aws-sdk-sagemaker 1.11.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sagemaker.rb +1 -1
- data/lib/aws-sdk-sagemaker/client.rb +318 -5
- data/lib/aws-sdk-sagemaker/client_api.rb +161 -0
- data/lib/aws-sdk-sagemaker/types.rb +675 -4
- metadata +2 -2
@@ -929,8 +929,7 @@ module Aws::SageMaker
|
|
929
929
|
#
|
930
930
|
# @!attribute [rw] training_job_name
|
931
931
|
# The name of the training job. The name must be unique within an AWS
|
932
|
-
# Region in an AWS account.
|
933
|
-
# console.
|
932
|
+
# Region in an AWS account.
|
934
933
|
# @return [String]
|
935
934
|
#
|
936
935
|
# @!attribute [rw] hyper_parameters
|
@@ -1074,6 +1073,138 @@ module Aws::SageMaker
|
|
1074
1073
|
include Aws::Structure
|
1075
1074
|
end
|
1076
1075
|
|
1076
|
+
# @note When making an API call, you may pass CreateTransformJobRequest
|
1077
|
+
# data as a hash:
|
1078
|
+
#
|
1079
|
+
# {
|
1080
|
+
# transform_job_name: "TransformJobName", # required
|
1081
|
+
# model_name: "ModelName", # required
|
1082
|
+
# max_concurrent_transforms: 1,
|
1083
|
+
# max_payload_in_mb: 1,
|
1084
|
+
# batch_strategy: "MultiRecord", # accepts MultiRecord, SingleRecord
|
1085
|
+
# environment: {
|
1086
|
+
# "TransformEnvironmentKey" => "TransformEnvironmentValue",
|
1087
|
+
# },
|
1088
|
+
# transform_input: { # required
|
1089
|
+
# data_source: { # required
|
1090
|
+
# s3_data_source: { # required
|
1091
|
+
# s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
|
1092
|
+
# s3_uri: "S3Uri", # required
|
1093
|
+
# },
|
1094
|
+
# },
|
1095
|
+
# content_type: "ContentType",
|
1096
|
+
# compression_type: "None", # accepts None, Gzip
|
1097
|
+
# split_type: "None", # accepts None, Line, RecordIO
|
1098
|
+
# },
|
1099
|
+
# transform_output: { # required
|
1100
|
+
# s3_output_path: "S3Uri", # required
|
1101
|
+
# accept: "Accept",
|
1102
|
+
# assemble_with: "None", # accepts None, Line
|
1103
|
+
# kms_key_id: "KmsKeyId",
|
1104
|
+
# },
|
1105
|
+
# transform_resources: { # required
|
1106
|
+
# instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge
|
1107
|
+
# instance_count: 1, # required
|
1108
|
+
# },
|
1109
|
+
# tags: [
|
1110
|
+
# {
|
1111
|
+
# key: "TagKey", # required
|
1112
|
+
# value: "TagValue", # required
|
1113
|
+
# },
|
1114
|
+
# ],
|
1115
|
+
# }
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] transform_job_name
|
1118
|
+
# The name of the transform job. The name must be unique within an AWS
|
1119
|
+
# Region in an AWS account.
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @!attribute [rw] model_name
|
1123
|
+
# The name of the model that you want to use for the transform job.
|
1124
|
+
# @return [String]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] max_concurrent_transforms
|
1127
|
+
# The maximum number of parallel requests on each instance node that
|
1128
|
+
# can be launched in a transform job. The default value is `1`. To
|
1129
|
+
# allow Amazon SageMaker to determine the appropriate number for
|
1130
|
+
# `MaxConcurrentTransforms`, set the value to `0`.
|
1131
|
+
# @return [Integer]
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] max_payload_in_mb
|
1134
|
+
# The maximum payload size allowed, in MB. A payload is the data
|
1135
|
+
# portion of a record (without metadata). The value in
|
1136
|
+
# `MaxPayloadInMB` must be greater than the size of a single
|
1137
|
+
# record.You can approximate the size of a record by dividing the size
|
1138
|
+
# of your dataset by the number of records. The value you enter should
|
1139
|
+
# be proportional to the number of records you want per batch. It is
|
1140
|
+
# recommended to enter a slightly higher value to ensure the records
|
1141
|
+
# will fit within the maximum payload size. The default value is `6`
|
1142
|
+
# MB. For an unlimited payload size, set the value to `0`.
|
1143
|
+
# @return [Integer]
|
1144
|
+
#
|
1145
|
+
# @!attribute [rw] batch_strategy
|
1146
|
+
# Determins the number of records included in a single batch.
|
1147
|
+
# `SingleRecord` means only one record is used per batch.
|
1148
|
+
# `MultiRecord` means a batch is set to contain as many records that
|
1149
|
+
# could possibly fit within the `MaxPayloadInMB` limit.
|
1150
|
+
# @return [String]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] environment
|
1153
|
+
# The environment variables to set in the Docker container. We support
|
1154
|
+
# up to 16 key and values entries in the map.
|
1155
|
+
# @return [Hash<String,String>]
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] transform_input
|
1158
|
+
# Describes the input source and the way the transform job consumes
|
1159
|
+
# it.
|
1160
|
+
# @return [Types::TransformInput]
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] transform_output
|
1163
|
+
# Describes the results of the transform job.
|
1164
|
+
# @return [Types::TransformOutput]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] transform_resources
|
1167
|
+
# Describes the resources, including ML instance types and ML instance
|
1168
|
+
# count, to use for the transform job.
|
1169
|
+
# @return [Types::TransformResources]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] tags
|
1172
|
+
# An array of key-value pairs. Adding tags is optional. For more
|
1173
|
+
# information, see [Using Cost Allocation Tags][1] in the *AWS Billing
|
1174
|
+
# and Cost Management User Guide*.
|
1175
|
+
#
|
1176
|
+
#
|
1177
|
+
#
|
1178
|
+
# [1]: http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what
|
1179
|
+
# @return [Array<Types::Tag>]
|
1180
|
+
#
|
1181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTransformJobRequest AWS API Documentation
|
1182
|
+
#
|
1183
|
+
class CreateTransformJobRequest < Struct.new(
|
1184
|
+
:transform_job_name,
|
1185
|
+
:model_name,
|
1186
|
+
:max_concurrent_transforms,
|
1187
|
+
:max_payload_in_mb,
|
1188
|
+
:batch_strategy,
|
1189
|
+
:environment,
|
1190
|
+
:transform_input,
|
1191
|
+
:transform_output,
|
1192
|
+
:transform_resources,
|
1193
|
+
:tags)
|
1194
|
+
include Aws::Structure
|
1195
|
+
end
|
1196
|
+
|
1197
|
+
# @!attribute [rw] transform_job_arn
|
1198
|
+
# The Amazon Resource Name (ARN) of the transform job.
|
1199
|
+
# @return [String]
|
1200
|
+
#
|
1201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreateTransformJobResponse AWS API Documentation
|
1202
|
+
#
|
1203
|
+
class CreateTransformJobResponse < Struct.new(
|
1204
|
+
:transform_job_arn)
|
1205
|
+
include Aws::Structure
|
1206
|
+
end
|
1207
|
+
|
1077
1208
|
# Describes the location of the channel data.
|
1078
1209
|
#
|
1079
1210
|
# @note When making an API call, you may pass DataSource
|
@@ -1854,6 +1985,115 @@ module Aws::SageMaker
|
|
1854
1985
|
include Aws::Structure
|
1855
1986
|
end
|
1856
1987
|
|
1988
|
+
# @note When making an API call, you may pass DescribeTransformJobRequest
|
1989
|
+
# data as a hash:
|
1990
|
+
#
|
1991
|
+
# {
|
1992
|
+
# transform_job_name: "TransformJobName", # required
|
1993
|
+
# }
|
1994
|
+
#
|
1995
|
+
# @!attribute [rw] transform_job_name
|
1996
|
+
# The name of the transform job that you want to view details of.
|
1997
|
+
# @return [String]
|
1998
|
+
#
|
1999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTransformJobRequest AWS API Documentation
|
2000
|
+
#
|
2001
|
+
class DescribeTransformJobRequest < Struct.new(
|
2002
|
+
:transform_job_name)
|
2003
|
+
include Aws::Structure
|
2004
|
+
end
|
2005
|
+
|
2006
|
+
# @!attribute [rw] transform_job_name
|
2007
|
+
# The name of the transform job.
|
2008
|
+
# @return [String]
|
2009
|
+
#
|
2010
|
+
# @!attribute [rw] transform_job_arn
|
2011
|
+
# The Amazon Resource Name (ARN) of the transform job.
|
2012
|
+
# @return [String]
|
2013
|
+
#
|
2014
|
+
# @!attribute [rw] transform_job_status
|
2015
|
+
# The status of the transform job. If the transform job failed, the
|
2016
|
+
# reason is returned in the `FailureReason` field.
|
2017
|
+
# @return [String]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] failure_reason
|
2020
|
+
# If the transform job failed, the reason that it failed.
|
2021
|
+
# @return [String]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] model_name
|
2024
|
+
# The name of the model used in the transform job.
|
2025
|
+
# @return [String]
|
2026
|
+
#
|
2027
|
+
# @!attribute [rw] max_concurrent_transforms
|
2028
|
+
# The maximum number of parallel requests on each instance node that
|
2029
|
+
# can be launched in a transform job. The default value is 1.
|
2030
|
+
# @return [Integer]
|
2031
|
+
#
|
2032
|
+
# @!attribute [rw] max_payload_in_mb
|
2033
|
+
# The maximum payload size , in MB used in the transform job.
|
2034
|
+
# @return [Integer]
|
2035
|
+
#
|
2036
|
+
# @!attribute [rw] batch_strategy
|
2037
|
+
# SingleRecord means only one record was used per a batch.
|
2038
|
+
# <code>MultiRecord</code> means batches contained as many
|
2039
|
+
# records that could possibly fit within the `MaxPayloadInMB` limit.
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] environment
|
2043
|
+
# @return [Hash<String,String>]
|
2044
|
+
#
|
2045
|
+
# @!attribute [rw] transform_input
|
2046
|
+
# Describes the dataset to be transformed and the Amazon S3 location
|
2047
|
+
# where it is stored.
|
2048
|
+
# @return [Types::TransformInput]
|
2049
|
+
#
|
2050
|
+
# @!attribute [rw] transform_output
|
2051
|
+
# Identifies the Amazon S3 location where you want Amazon SageMaker to
|
2052
|
+
# save the results from the transform job.
|
2053
|
+
# @return [Types::TransformOutput]
|
2054
|
+
#
|
2055
|
+
# @!attribute [rw] transform_resources
|
2056
|
+
# Describes the resources, including ML instance types and ML instance
|
2057
|
+
# count, to use for the transform job.
|
2058
|
+
# @return [Types::TransformResources]
|
2059
|
+
#
|
2060
|
+
# @!attribute [rw] creation_time
|
2061
|
+
# A timestamp that shows when the transform Job was created.
|
2062
|
+
# @return [Time]
|
2063
|
+
#
|
2064
|
+
# @!attribute [rw] transform_start_time
|
2065
|
+
# Indicates when the transform job starts on ML instances. You are
|
2066
|
+
# billed for the time interval between this time and the value of
|
2067
|
+
# `TransformEndTime`.
|
2068
|
+
# @return [Time]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] transform_end_time
|
2071
|
+
# Indicates when the transform job is `Completed`, `Stopped`, or
|
2072
|
+
# `Failed`. You are billed for the time interval between this time and
|
2073
|
+
# the value of `TransformStartTime`.
|
2074
|
+
# @return [Time]
|
2075
|
+
#
|
2076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/DescribeTransformJobResponse AWS API Documentation
|
2077
|
+
#
|
2078
|
+
class DescribeTransformJobResponse < Struct.new(
|
2079
|
+
:transform_job_name,
|
2080
|
+
:transform_job_arn,
|
2081
|
+
:transform_job_status,
|
2082
|
+
:failure_reason,
|
2083
|
+
:model_name,
|
2084
|
+
:max_concurrent_transforms,
|
2085
|
+
:max_payload_in_mb,
|
2086
|
+
:batch_strategy,
|
2087
|
+
:environment,
|
2088
|
+
:transform_input,
|
2089
|
+
:transform_output,
|
2090
|
+
:transform_resources,
|
2091
|
+
:creation_time,
|
2092
|
+
:transform_start_time,
|
2093
|
+
:transform_end_time)
|
2094
|
+
include Aws::Structure
|
2095
|
+
end
|
2096
|
+
|
1857
2097
|
# Specifies weight and capacity values for a production variant.
|
1858
2098
|
#
|
1859
2099
|
# @note When making an API call, you may pass DesiredWeightAndCapacity
|
@@ -3147,8 +3387,8 @@ module Aws::SageMaker
|
|
3147
3387
|
# @return [Integer]
|
3148
3388
|
#
|
3149
3389
|
# @!attribute [rw] creation_time_after
|
3150
|
-
# A filter that only training jobs created after the specified
|
3151
|
-
# (timestamp).
|
3390
|
+
# A filter that returns only training jobs created after the specified
|
3391
|
+
# time (timestamp).
|
3152
3392
|
# @return [Time]
|
3153
3393
|
#
|
3154
3394
|
# @!attribute [rw] creation_time_before
|
@@ -3218,6 +3458,104 @@ module Aws::SageMaker
|
|
3218
3458
|
include Aws::Structure
|
3219
3459
|
end
|
3220
3460
|
|
3461
|
+
# @note When making an API call, you may pass ListTransformJobsRequest
|
3462
|
+
# data as a hash:
|
3463
|
+
#
|
3464
|
+
# {
|
3465
|
+
# creation_time_after: Time.now,
|
3466
|
+
# creation_time_before: Time.now,
|
3467
|
+
# last_modified_time_after: Time.now,
|
3468
|
+
# last_modified_time_before: Time.now,
|
3469
|
+
# name_contains: "NameContains",
|
3470
|
+
# status_equals: "InProgress", # accepts InProgress, Completed, Failed, Stopping, Stopped
|
3471
|
+
# sort_by: "Name", # accepts Name, CreationTime, Status
|
3472
|
+
# sort_order: "Ascending", # accepts Ascending, Descending
|
3473
|
+
# next_token: "NextToken",
|
3474
|
+
# max_results: 1,
|
3475
|
+
# }
|
3476
|
+
#
|
3477
|
+
# @!attribute [rw] creation_time_after
|
3478
|
+
# A filter that returns only transform jobs created after the
|
3479
|
+
# specified time.
|
3480
|
+
# @return [Time]
|
3481
|
+
#
|
3482
|
+
# @!attribute [rw] creation_time_before
|
3483
|
+
# A filter that returns only transform jobs created before the
|
3484
|
+
# specified time.
|
3485
|
+
# @return [Time]
|
3486
|
+
#
|
3487
|
+
# @!attribute [rw] last_modified_time_after
|
3488
|
+
# A filter that returns only transform jobs modified after the
|
3489
|
+
# specified time.
|
3490
|
+
# @return [Time]
|
3491
|
+
#
|
3492
|
+
# @!attribute [rw] last_modified_time_before
|
3493
|
+
# A filter that returns only transform jobs modified before the
|
3494
|
+
# specified time.
|
3495
|
+
# @return [Time]
|
3496
|
+
#
|
3497
|
+
# @!attribute [rw] name_contains
|
3498
|
+
# A string in the transform job name. This filter returns only
|
3499
|
+
# transform jobs whose name contains the specified string.
|
3500
|
+
# @return [String]
|
3501
|
+
#
|
3502
|
+
# @!attribute [rw] status_equals
|
3503
|
+
# A filter that retrieves only transform jobs with a specific status.
|
3504
|
+
# @return [String]
|
3505
|
+
#
|
3506
|
+
# @!attribute [rw] sort_by
|
3507
|
+
# The field to sort results by. The default is `CreationTime`.
|
3508
|
+
# @return [String]
|
3509
|
+
#
|
3510
|
+
# @!attribute [rw] sort_order
|
3511
|
+
# The sort order for results. The default is `Descending`.
|
3512
|
+
# @return [String]
|
3513
|
+
#
|
3514
|
+
# @!attribute [rw] next_token
|
3515
|
+
# If the result of the previous `ListTransformJobs` request was
|
3516
|
+
# truncated, the response includes a `NextToken`. To retrieve the next
|
3517
|
+
# set of transform jobs, use the token in the next request.
|
3518
|
+
# @return [String]
|
3519
|
+
#
|
3520
|
+
# @!attribute [rw] max_results
|
3521
|
+
# The maximum number of transform jobs to return in the response. The
|
3522
|
+
# default value is `10`.
|
3523
|
+
# @return [Integer]
|
3524
|
+
#
|
3525
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTransformJobsRequest AWS API Documentation
|
3526
|
+
#
|
3527
|
+
class ListTransformJobsRequest < Struct.new(
|
3528
|
+
:creation_time_after,
|
3529
|
+
:creation_time_before,
|
3530
|
+
:last_modified_time_after,
|
3531
|
+
:last_modified_time_before,
|
3532
|
+
:name_contains,
|
3533
|
+
:status_equals,
|
3534
|
+
:sort_by,
|
3535
|
+
:sort_order,
|
3536
|
+
:next_token,
|
3537
|
+
:max_results)
|
3538
|
+
include Aws::Structure
|
3539
|
+
end
|
3540
|
+
|
3541
|
+
# @!attribute [rw] transform_job_summaries
|
3542
|
+
# An array of `TransformJobSummary` objects.
|
3543
|
+
# @return [Array<Types::TransformJobSummary>]
|
3544
|
+
#
|
3545
|
+
# @!attribute [rw] next_token
|
3546
|
+
# If the response is truncated, Amazon SageMaker returns this token.
|
3547
|
+
# To retrieve the next set of transform jobs, use it in the next
|
3548
|
+
# request.
|
3549
|
+
# @return [String]
|
3550
|
+
#
|
3551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListTransformJobsResponse AWS API Documentation
|
3552
|
+
#
|
3553
|
+
class ListTransformJobsResponse < Struct.new(
|
3554
|
+
:transform_job_summaries,
|
3555
|
+
:next_token)
|
3556
|
+
include Aws::Structure
|
3557
|
+
end
|
3558
|
+
|
3221
3559
|
# Specifies a metric that the training algorithm writes to `stderr` or
|
3222
3560
|
# `stdout`. Amazon SageMakerHyperparamter tuning captures all defined
|
3223
3561
|
# metrics. You specify one metric that a hyperparameter tuning job uses
|
@@ -3892,6 +4230,24 @@ module Aws::SageMaker
|
|
3892
4230
|
include Aws::Structure
|
3893
4231
|
end
|
3894
4232
|
|
4233
|
+
# @note When making an API call, you may pass StopTransformJobRequest
|
4234
|
+
# data as a hash:
|
4235
|
+
#
|
4236
|
+
# {
|
4237
|
+
# transform_job_name: "TransformJobName", # required
|
4238
|
+
# }
|
4239
|
+
#
|
4240
|
+
# @!attribute [rw] transform_job_name
|
4241
|
+
# The name of the transform job to stop.
|
4242
|
+
# @return [String]
|
4243
|
+
#
|
4244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/StopTransformJobRequest AWS API Documentation
|
4245
|
+
#
|
4246
|
+
class StopTransformJobRequest < Struct.new(
|
4247
|
+
:transform_job_name)
|
4248
|
+
include Aws::Structure
|
4249
|
+
end
|
4250
|
+
|
3895
4251
|
# Specifies how long model training can run. When model training reaches
|
3896
4252
|
# the limit, Amazon SageMaker ends the training job. Use this API to cap
|
3897
4253
|
# model training cost.
|
@@ -4035,6 +4391,321 @@ module Aws::SageMaker
|
|
4035
4391
|
include Aws::Structure
|
4036
4392
|
end
|
4037
4393
|
|
4394
|
+
# Describes the location of the channel data.
|
4395
|
+
#
|
4396
|
+
# @note When making an API call, you may pass TransformDataSource
|
4397
|
+
# data as a hash:
|
4398
|
+
#
|
4399
|
+
# {
|
4400
|
+
# s3_data_source: { # required
|
4401
|
+
# s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
|
4402
|
+
# s3_uri: "S3Uri", # required
|
4403
|
+
# },
|
4404
|
+
# }
|
4405
|
+
#
|
4406
|
+
# @!attribute [rw] s3_data_source
|
4407
|
+
# The S3 location of the data source that is associated with a
|
4408
|
+
# channel.
|
4409
|
+
# @return [Types::TransformS3DataSource]
|
4410
|
+
#
|
4411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TransformDataSource AWS API Documentation
|
4412
|
+
#
|
4413
|
+
class TransformDataSource < Struct.new(
|
4414
|
+
:s3_data_source)
|
4415
|
+
include Aws::Structure
|
4416
|
+
end
|
4417
|
+
|
4418
|
+
# Describes the input source of a transform job and the way the
|
4419
|
+
# transform job consumes it.
|
4420
|
+
#
|
4421
|
+
# @note When making an API call, you may pass TransformInput
|
4422
|
+
# data as a hash:
|
4423
|
+
#
|
4424
|
+
# {
|
4425
|
+
# data_source: { # required
|
4426
|
+
# s3_data_source: { # required
|
4427
|
+
# s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
|
4428
|
+
# s3_uri: "S3Uri", # required
|
4429
|
+
# },
|
4430
|
+
# },
|
4431
|
+
# content_type: "ContentType",
|
4432
|
+
# compression_type: "None", # accepts None, Gzip
|
4433
|
+
# split_type: "None", # accepts None, Line, RecordIO
|
4434
|
+
# }
|
4435
|
+
#
|
4436
|
+
# @!attribute [rw] data_source
|
4437
|
+
# Describes the location of the channel data, meaning the S3 location
|
4438
|
+
# of the input data that the model can consume.
|
4439
|
+
# @return [Types::TransformDataSource]
|
4440
|
+
#
|
4441
|
+
# @!attribute [rw] content_type
|
4442
|
+
# The multipurpose internet mail extension (MIME) type of the data.
|
4443
|
+
# Amazon SageMaker uses the MIME type with each http call to transfer
|
4444
|
+
# data to the transform job.
|
4445
|
+
# @return [String]
|
4446
|
+
#
|
4447
|
+
# @!attribute [rw] compression_type
|
4448
|
+
# Compressing data helps save on storage space. If your transform data
|
4449
|
+
# is compressed, specify the compression type.and Amazon SageMaker
|
4450
|
+
# will automatically decompress the data for the transform job
|
4451
|
+
# accordingly. The default value is `None`.
|
4452
|
+
# @return [String]
|
4453
|
+
#
|
4454
|
+
# @!attribute [rw] split_type
|
4455
|
+
# The method to use to split the transform job's data into smaller
|
4456
|
+
# batches. The default value is `None`. If you don't want to split
|
4457
|
+
# the data, specify (`None`). If you want to split records on a
|
4458
|
+
# newline character boundary, specify `Line`. To split records
|
4459
|
+
# according to the RecordIO format, specify `RecordIO`.
|
4460
|
+
#
|
4461
|
+
# Amazon SageMaker will send maximum number of records per batch in
|
4462
|
+
# each request up to the MaxPayloadInMB limit. For more information,
|
4463
|
+
# see [RecordIO data format][1].
|
4464
|
+
#
|
4465
|
+
# <note markdown="1"> For information about the `RecordIO` format, see [Data Format][1].
|
4466
|
+
#
|
4467
|
+
# </note>
|
4468
|
+
#
|
4469
|
+
#
|
4470
|
+
#
|
4471
|
+
# [1]: http://mxnet.io/architecture/note_data_loading.html#data-format
|
4472
|
+
# @return [String]
|
4473
|
+
#
|
4474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TransformInput AWS API Documentation
|
4475
|
+
#
|
4476
|
+
class TransformInput < Struct.new(
|
4477
|
+
:data_source,
|
4478
|
+
:content_type,
|
4479
|
+
:compression_type,
|
4480
|
+
:split_type)
|
4481
|
+
include Aws::Structure
|
4482
|
+
end
|
4483
|
+
|
4484
|
+
# Provides a summary information for a transform job. Multiple
|
4485
|
+
# TransformJobSummary objects are returned as a list after calling
|
4486
|
+
# ListTransformJobs.
|
4487
|
+
#
|
4488
|
+
# @!attribute [rw] transform_job_name
|
4489
|
+
# The name of the transform job.
|
4490
|
+
# @return [String]
|
4491
|
+
#
|
4492
|
+
# @!attribute [rw] transform_job_arn
|
4493
|
+
# The Amazon Resource Name (ARN) of the transform job.
|
4494
|
+
# @return [String]
|
4495
|
+
#
|
4496
|
+
# @!attribute [rw] creation_time
|
4497
|
+
# A timestamp that shows when the transform Job was created.
|
4498
|
+
# @return [Time]
|
4499
|
+
#
|
4500
|
+
# @!attribute [rw] transform_end_time
|
4501
|
+
# Indicates when the transform job ends on compute instances. For
|
4502
|
+
# successful jobs and stopped jobs, this is the exact time recorded
|
4503
|
+
# after the results are uploaded. For failed jobs, this is when Amazon
|
4504
|
+
# SageMaker detected that the job failed.
|
4505
|
+
# @return [Time]
|
4506
|
+
#
|
4507
|
+
# @!attribute [rw] last_modified_time
|
4508
|
+
# Indicates when the transform job was last modified.
|
4509
|
+
# @return [Time]
|
4510
|
+
#
|
4511
|
+
# @!attribute [rw] transform_job_status
|
4512
|
+
# The status of the transform job.
|
4513
|
+
# @return [String]
|
4514
|
+
#
|
4515
|
+
# @!attribute [rw] failure_reason
|
4516
|
+
# If the transform job failed, the reason it failed.
|
4517
|
+
# @return [String]
|
4518
|
+
#
|
4519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TransformJobSummary AWS API Documentation
|
4520
|
+
#
|
4521
|
+
class TransformJobSummary < Struct.new(
|
4522
|
+
:transform_job_name,
|
4523
|
+
:transform_job_arn,
|
4524
|
+
:creation_time,
|
4525
|
+
:transform_end_time,
|
4526
|
+
:last_modified_time,
|
4527
|
+
:transform_job_status,
|
4528
|
+
:failure_reason)
|
4529
|
+
include Aws::Structure
|
4530
|
+
end
|
4531
|
+
|
4532
|
+
# Describes the results of a transform job output.
|
4533
|
+
#
|
4534
|
+
# @note When making an API call, you may pass TransformOutput
|
4535
|
+
# data as a hash:
|
4536
|
+
#
|
4537
|
+
# {
|
4538
|
+
# s3_output_path: "S3Uri", # required
|
4539
|
+
# accept: "Accept",
|
4540
|
+
# assemble_with: "None", # accepts None, Line
|
4541
|
+
# kms_key_id: "KmsKeyId",
|
4542
|
+
# }
|
4543
|
+
#
|
4544
|
+
# @!attribute [rw] s3_output_path
|
4545
|
+
# The Amazon S3 path where you want Amazon SageMaker to store the
|
4546
|
+
# results of the transform job. For example,
|
4547
|
+
# `s3://bucket-name/key-name-prefix`.
|
4548
|
+
#
|
4549
|
+
# For every S3 object used as input for the transform job, the
|
4550
|
+
# transformed data is stored in a corresponding subfolder in the
|
4551
|
+
# location under the output prefix.For example, the input data
|
4552
|
+
# `s3://bucket-name/input-name-prefix/dataset01/data.csv` will have
|
4553
|
+
# the transformed data stored at
|
4554
|
+
# `s3://bucket-name/key-name-prefix/dataset01/`, based on the original
|
4555
|
+
# name, as a series of .part files (.part0001, part0002, etc).
|
4556
|
+
# @return [String]
|
4557
|
+
#
|
4558
|
+
# @!attribute [rw] accept
|
4559
|
+
# The MIME type used to specify the output data. Amazon SageMaker uses
|
4560
|
+
# the MIME type with each http call to transfer data from the
|
4561
|
+
# transform job.
|
4562
|
+
# @return [String]
|
4563
|
+
#
|
4564
|
+
# @!attribute [rw] assemble_with
|
4565
|
+
# Defines how to assemble the results of the transform job as a single
|
4566
|
+
# S3 object. You should select a format that is most convienant to
|
4567
|
+
# you. To concatenate the results in binary format, specify `None`. To
|
4568
|
+
# add a newline character at the end of every transformed record,
|
4569
|
+
# specify `Line`. To assemble the output in RecordIO format, specify
|
4570
|
+
# `RecordIO`. The default value is `None`.
|
4571
|
+
#
|
4572
|
+
# For information about the `RecordIO` format, see [Data Format][1].
|
4573
|
+
#
|
4574
|
+
#
|
4575
|
+
#
|
4576
|
+
# [1]: http://mxnet.io/architecture/note_data_loading.html#data-format
|
4577
|
+
# @return [String]
|
4578
|
+
#
|
4579
|
+
# @!attribute [rw] kms_key_id
|
4580
|
+
# The AWS Key Management Service (AWS KMS) key for Amazon S3
|
4581
|
+
# server-side encryption that Amazon SageMaker uses to encrypt the
|
4582
|
+
# transformed data.
|
4583
|
+
#
|
4584
|
+
# If you don't provide a KMS key ID, Amazon SageMaker uses the
|
4585
|
+
# default KMS key for Amazon S3 for your role's account. For more
|
4586
|
+
# information, see [KMS-Managed Encryption Keys][1] in the *Amazon
|
4587
|
+
# Simple Storage Service Developer Guide.*
|
4588
|
+
#
|
4589
|
+
# The KMS key policy must grant permission to the IAM role that you
|
4590
|
+
# specify in your `CreateTramsformJob` request. For more information,
|
4591
|
+
# see [Using Key Policies in AWS KMS][2] in the *AWS Key Management
|
4592
|
+
# Service Developer Guide*.
|
4593
|
+
#
|
4594
|
+
#
|
4595
|
+
#
|
4596
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
|
4597
|
+
# [2]: http://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html
|
4598
|
+
# @return [String]
|
4599
|
+
#
|
4600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TransformOutput AWS API Documentation
|
4601
|
+
#
|
4602
|
+
class TransformOutput < Struct.new(
|
4603
|
+
:s3_output_path,
|
4604
|
+
:accept,
|
4605
|
+
:assemble_with,
|
4606
|
+
:kms_key_id)
|
4607
|
+
include Aws::Structure
|
4608
|
+
end
|
4609
|
+
|
4610
|
+
# Describes the resources, including ML instance types and ML instance
|
4611
|
+
# count, to use for transform job.
|
4612
|
+
#
|
4613
|
+
# @note When making an API call, you may pass TransformResources
|
4614
|
+
# data as a hash:
|
4615
|
+
#
|
4616
|
+
# {
|
4617
|
+
# instance_type: "ml.m4.xlarge", # required, accepts ml.m4.xlarge, ml.m4.2xlarge, ml.m4.4xlarge, ml.m4.10xlarge, ml.m4.16xlarge, ml.c4.xlarge, ml.c4.2xlarge, ml.c4.4xlarge, ml.c4.8xlarge, ml.p2.xlarge, ml.p2.8xlarge, ml.p2.16xlarge, ml.p3.2xlarge, ml.p3.8xlarge, ml.p3.16xlarge, ml.c5.xlarge, ml.c5.2xlarge, ml.c5.4xlarge, ml.c5.9xlarge, ml.c5.18xlarge, ml.m5.large, ml.m5.xlarge, ml.m5.2xlarge, ml.m5.4xlarge, ml.m5.12xlarge, ml.m5.24xlarge
|
4618
|
+
# instance_count: 1, # required
|
4619
|
+
# }
|
4620
|
+
#
|
4621
|
+
# @!attribute [rw] instance_type
|
4622
|
+
# The ML compute instance type for the transform job. For using
|
4623
|
+
# built-in algorithms to transform moderately sized datasets,
|
4624
|
+
# ml.m4.xlarge or `ml.m5.large` should suffice. There is no default
|
4625
|
+
# value for `InstanceType`.
|
4626
|
+
# @return [String]
|
4627
|
+
#
|
4628
|
+
# @!attribute [rw] instance_count
|
4629
|
+
# The number of ML compute instances to use in the transform job. For
|
4630
|
+
# distributed transform, provide a value greater than 1. The default
|
4631
|
+
# value is `1`.
|
4632
|
+
# @return [Integer]
|
4633
|
+
#
|
4634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TransformResources AWS API Documentation
|
4635
|
+
#
|
4636
|
+
class TransformResources < Struct.new(
|
4637
|
+
:instance_type,
|
4638
|
+
:instance_count)
|
4639
|
+
include Aws::Structure
|
4640
|
+
end
|
4641
|
+
|
4642
|
+
# Describes the S3 data source.
|
4643
|
+
#
|
4644
|
+
# @note When making an API call, you may pass TransformS3DataSource
|
4645
|
+
# data as a hash:
|
4646
|
+
#
|
4647
|
+
# {
|
4648
|
+
# s3_data_type: "ManifestFile", # required, accepts ManifestFile, S3Prefix
|
4649
|
+
# s3_uri: "S3Uri", # required
|
4650
|
+
# }
|
4651
|
+
#
|
4652
|
+
# @!attribute [rw] s3_data_type
|
4653
|
+
# If you choose `S3Prefix`, `S3Uri` identifies a key name prefix.
|
4654
|
+
# Amazon SageMaker uses all objects with the specified key name prefix
|
4655
|
+
# for batch transform.
|
4656
|
+
#
|
4657
|
+
# If you choose `ManifestFile`, `S3Uri` identifies an object that is a
|
4658
|
+
# manifest file containing a list of object keys that you want Amazon
|
4659
|
+
# SageMaker to use for batch transform.
|
4660
|
+
# @return [String]
|
4661
|
+
#
|
4662
|
+
# @!attribute [rw] s3_uri
|
4663
|
+
# Depending on the value specified for the `S3DataType`, identifies
|
4664
|
+
# either a key name prefix or a manifest. For example:
|
4665
|
+
#
|
4666
|
+
# * A key name prefix might look like this:
|
4667
|
+
# `s3://bucketname/exampleprefix`.
|
4668
|
+
#
|
4669
|
+
# * A manifest might look like this:
|
4670
|
+
# `s3://bucketname/example.manifest`
|
4671
|
+
#
|
4672
|
+
# The manifest is an S3 object which is a JSON file with the
|
4673
|
+
# following format:
|
4674
|
+
#
|
4675
|
+
# `[`
|
4676
|
+
#
|
4677
|
+
# ` \{"prefix": "s3://customer_bucket/some/prefix/"\},`
|
4678
|
+
#
|
4679
|
+
# ` "relative/path/to/custdata-1",`
|
4680
|
+
#
|
4681
|
+
# ` "relative/path/custdata-2",`
|
4682
|
+
#
|
4683
|
+
# ` ...`
|
4684
|
+
#
|
4685
|
+
# ` ]`
|
4686
|
+
#
|
4687
|
+
# The preceding JSON matches the following `S3Uris`\:
|
4688
|
+
#
|
4689
|
+
# `s3://customer_bucket/some/prefix/relative/path/to/custdata-1`
|
4690
|
+
#
|
4691
|
+
# `s3://customer_bucket/some/prefix/relative/path/custdata-1`
|
4692
|
+
#
|
4693
|
+
# `...`
|
4694
|
+
#
|
4695
|
+
# The complete set of `S3Uris` in this manifest constitutes the
|
4696
|
+
# input data for the channel for this datasource. The object that
|
4697
|
+
# each `S3Uris` points to must be readable by the IAM role that
|
4698
|
+
# Amazon SageMaker uses to perform tasks on your behalf.
|
4699
|
+
# @return [String]
|
4700
|
+
#
|
4701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/TransformS3DataSource AWS API Documentation
|
4702
|
+
#
|
4703
|
+
class TransformS3DataSource < Struct.new(
|
4704
|
+
:s3_data_type,
|
4705
|
+
:s3_uri)
|
4706
|
+
include Aws::Structure
|
4707
|
+
end
|
4708
|
+
|
4038
4709
|
# @note When making an API call, you may pass UpdateEndpointInput
|
4039
4710
|
# data as a hash:
|
4040
4711
|
#
|