AmazonS3Dataset Class
A single Amazon Simple Storage Service (S3) object or a set of S3 objects.
All required parameters must be populated in order to send to server.
- Inheritance
-
azure.mgmt.datafactory.models._models_py3.DatasetAmazonS3Dataset
Constructor
AmazonS3Dataset(*, linked_service_name: _models.LinkedServiceReference, bucket_name: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder | None = None, key: MutableMapping[str, Any] | None = None, prefix: MutableMapping[str, Any] | None = None, version: MutableMapping[str, Any] | None = None, modified_datetime_start: MutableMapping[str, Any] | None = None, modified_datetime_end: MutableMapping[str, Any] | None = None, format: _models.DatasetStorageFormat | None = None, compression: _models.DatasetCompression | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
description
|
Dataset description. |
|
structure
|
<xref:JSON>
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
|
schema
|
<xref:JSON>
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
|
linked_service_name
|
Linked service reference. Required. |
|
parameters
|
Parameters for dataset. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the Dataset. |
|
folder
|
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
bucket_name
|
<xref:JSON>
The name of the Amazon S3 bucket. Type: string (or Expression with resultType string). Required. |
|
key
|
<xref:JSON>
The key of the Amazon S3 object. Type: string (or Expression with resultType string). |
|
prefix
|
<xref:JSON>
The prefix filter for the S3 object name. Type: string (or Expression with resultType string). |
|
version
|
<xref:JSON>
The version for the S3 object. Type: string (or Expression with resultType string). |
|
modified_datetime_start
|
<xref:JSON>
The start of S3 object's modified datetime. Type: string (or Expression with resultType string). |
|
modified_datetime_end
|
<xref:JSON>
The end of S3 object's modified datetime. Type: string (or Expression with resultType string). |
|
format
|
The format of files. |
|
compression
|
The data compression method used for the Amazon S3 object. |
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of dataset. Required. |
|
description
|
Dataset description. |
|
structure
|
<xref:JSON>
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. |
|
schema
|
<xref:JSON>
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. |
|
linked_service_name
|
Linked service reference. Required. |
|
parameters
|
Parameters for dataset. |
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the Dataset. |
|
folder
|
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. |
|
bucket_name
|
<xref:JSON>
The name of the Amazon S3 bucket. Type: string (or Expression with resultType string). Required. |
|
key
|
<xref:JSON>
The key of the Amazon S3 object. Type: string (or Expression with resultType string). |
|
prefix
|
<xref:JSON>
The prefix filter for the S3 object name. Type: string (or Expression with resultType string). |
|
version
|
<xref:JSON>
The version for the S3 object. Type: string (or Expression with resultType string). |
|
modified_datetime_start
|
<xref:JSON>
The start of S3 object's modified datetime. Type: string (or Expression with resultType string). |
|
modified_datetime_end
|
<xref:JSON>
The end of S3 object's modified datetime. Type: string (or Expression with resultType string). |
|
format
|
The format of files. |
|
compression
|
The data compression method used for the Amazon S3 object. |
Azure SDK for Python