Class CfnModel.S3DataSourceProperty
Describes the S3 data source.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Sagemaker
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnModel.S3DataSourceProperty : CfnModel.IS3DataSourceProperty
Syntax (vb)
Public Class CfnModel.S3DataSourceProperty Implements CfnModel.IS3DataSourceProperty
Remarks
Your input bucket must be in the same AWS region as your training job.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var s3DataSourceProperty = new S3DataSourceProperty {
CompressionType = "compressionType",
S3DataType = "s3DataType",
S3Uri = "s3Uri",
// the properties below are optional
HubAccessConfig = new HubAccessConfigProperty {
HubContentArn = "hubContentArn"
},
ModelAccessConfig = new ModelAccessConfigProperty {
AcceptEula = false
}
};
Synopsis
Constructors
S3DataSourceProperty() | Describes the S3 data source. |
Properties
CompressionType | Describes the S3 data source. |
HubAccessConfig | The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model. |
ModelAccessConfig | Describes the S3 data source. |
S3DataType | If you choose |
S3Uri | Depending on the value specified for the |
Constructors
S3DataSourceProperty()
Describes the S3 data source.
public S3DataSourceProperty()
Remarks
Your input bucket must be in the same AWS region as your training job.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;
var s3DataSourceProperty = new S3DataSourceProperty {
CompressionType = "compressionType",
S3DataType = "s3DataType",
S3Uri = "s3Uri",
// the properties below are optional
HubAccessConfig = new HubAccessConfigProperty {
HubContentArn = "hubContentArn"
},
ModelAccessConfig = new ModelAccessConfigProperty {
AcceptEula = false
}
};
Properties
CompressionType
Describes the S3 data source.
public string CompressionType { get; set; }
Property Value
Remarks
HubAccessConfig
The configuration for a private hub model reference that points to a SageMaker JumpStart public hub model.
public object? HubAccessConfig { get; set; }
Property Value
Remarks
ModelAccessConfig
Describes the S3 data source.
public object? ModelAccessConfig { get; set; }
Property Value
Remarks
S3DataType
If you choose S3Prefix
, S3Uri
identifies a key name prefix.
public string S3DataType { get; set; }
Property Value
Remarks
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
.
S3Uri
Depending on the value specified for the S3DataType
, identifies either a key name prefix or a manifest.
public string S3Uri { get; set; }
Property Value
Remarks
For example:
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.
Your input bucket must be located in same AWS region as your training job.