/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.sagemaker.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes the Amazon S3 data source. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AutoMLS3DataSource implements Serializable, Cloneable, StructuredPojo { /** ** The data type. *
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all objects
* that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs created by calling
* CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the * data type. *
*/ private String s3Uri; /** ** The data type. *
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all objects
* that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs created by calling
* CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all
* objects that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs
* created by calling CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* The data type. *
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all objects
* that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs created by calling
* CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all
* objects that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs
* created by calling CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata
* to Training Jobs with an Augmented Manifest File.
*
* The data type. *
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all objects
* that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs created by calling
* CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all
* objects that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs
* created by calling CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* The data type. *
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all objects
* that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs created by calling
* CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* If you choose S3Prefix
, S3Uri
identifies a key name prefix. SageMaker uses all
* objects that match the specified key name prefix for model training.
*
* The S3Prefix
should have the following format:
*
* s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER-OR-FILE
*
* 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.
*
* 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" ]
*
* 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
is available for V2 API jobs only (for example, for jobs
* created by calling CreateAutoMLJobV2
).
*
* Here is a minimal, single-record example of an AugmentedManifestFile
:
*
* {"source-ref": "s3://DOC-EXAMPLE-BUCKET/DOC-EXAMPLE-FOLDER/cats/cat.jpg",
*
* "label-metadata": {"class-name": "cat"
*
* For more information on AugmentedManifestFile
, see Provide Dataset Metadata to
* Training Jobs with an Augmented Manifest File.
*
* The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the * data type. *
* * @param s3Uri * The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on * the data type. */ public void setS3Uri(String s3Uri) { this.s3Uri = s3Uri; } /** ** The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the * data type. *
* * @return The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on * the data type. */ public String getS3Uri() { return this.s3Uri; } /** ** The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on the * data type. *
* * @param s3Uri * The URL to the Amazon S3 data source. The Uri refers to the Amazon S3 prefix or ManifestFile depending on * the data type. * @return Returns a reference to this object so that method calls can be chained together. */ public AutoMLS3DataSource withS3Uri(String s3Uri) { setS3Uri(s3Uri); return this; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getS3DataType() != null) sb.append("S3DataType: ").append(getS3DataType()).append(","); if (getS3Uri() != null) sb.append("S3Uri: ").append(getS3Uri()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AutoMLS3DataSource == false) return false; AutoMLS3DataSource other = (AutoMLS3DataSource) obj; if (other.getS3DataType() == null ^ this.getS3DataType() == null) return false; if (other.getS3DataType() != null && other.getS3DataType().equals(this.getS3DataType()) == false) return false; if (other.getS3Uri() == null ^ this.getS3Uri() == null) return false; if (other.getS3Uri() != null && other.getS3Uri().equals(this.getS3Uri()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getS3DataType() == null) ? 0 : getS3DataType().hashCode()); hashCode = prime * hashCode + ((getS3Uri() == null) ? 0 : getS3Uri().hashCode()); return hashCode; } @Override public AutoMLS3DataSource clone() { try { return (AutoMLS3DataSource) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.sagemaker.model.transform.AutoMLS3DataSourceMarshaller.getInstance().marshall(this, protocolMarshaller); } }