1. Packages
  2. AWS Native
  3. API Docs
  4. personalize
  5. Dataset

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.personalize.Dataset

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource schema for AWS::Personalize::Dataset.

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var myDataset = new AwsNative.Personalize.Dataset("myDataset", new()
        {
            Name = "my-dataset-name",
            DatasetType = AwsNative.Personalize.DatasetType.Interactions,
            DatasetGroupArn = "arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name",
            SchemaArn = "arn:aws:personalize:us-west-2:123456789012:schema/schema-name",
            DatasetImportJob = new AwsNative.Personalize.Inputs.DatasetImportJobArgs
            {
                JobName = "my-import-job-name",
                DataSource = new AwsNative.Personalize.Inputs.DatasetImportJobDataSourcePropertiesArgs
                {
                    DataLocation = "s3://bucket-name/file-name.csv",
                },
                RoleArn = "arn:aws:iam::123456789012:role/personalize-role",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/personalize"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := personalize.NewDataset(ctx, "myDataset", &personalize.DatasetArgs{
    			Name:            pulumi.String("my-dataset-name"),
    			DatasetType:     personalize.DatasetTypeInteractions,
    			DatasetGroupArn: pulumi.String("arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name"),
    			SchemaArn:       pulumi.String("arn:aws:personalize:us-west-2:123456789012:schema/schema-name"),
    			DatasetImportJob: &personalize.DatasetImportJobArgs{
    				JobName: pulumi.String("my-import-job-name"),
    				DataSource: &personalize.DatasetImportJobDataSourcePropertiesArgs{
    					DataLocation: pulumi.String("s3://bucket-name/file-name.csv"),
    				},
    				RoleArn: pulumi.String("arn:aws:iam::123456789012:role/personalize-role"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    my_dataset = aws_native.personalize.Dataset("myDataset",
        name="my-dataset-name",
        dataset_type=aws_native.personalize.DatasetType.INTERACTIONS,
        dataset_group_arn="arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name",
        schema_arn="arn:aws:personalize:us-west-2:123456789012:schema/schema-name",
        dataset_import_job=aws_native.personalize.DatasetImportJobArgs(
            job_name="my-import-job-name",
            data_source=aws_native.personalize.DatasetImportJobDataSourcePropertiesArgs(
                data_location="s3://bucket-name/file-name.csv",
            ),
            role_arn="arn:aws:iam::123456789012:role/personalize-role",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const myDataset = new aws_native.personalize.Dataset("myDataset", {
        name: "my-dataset-name",
        datasetType: aws_native.personalize.DatasetType.Interactions,
        datasetGroupArn: "arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name",
        schemaArn: "arn:aws:personalize:us-west-2:123456789012:schema/schema-name",
        datasetImportJob: {
            jobName: "my-import-job-name",
            dataSource: {
                dataLocation: "s3://bucket-name/file-name.csv",
            },
            roleArn: "arn:aws:iam::123456789012:role/personalize-role",
        },
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var myDataset = new AwsNative.Personalize.Dataset("myDataset", new()
        {
            Name = "my-dataset-name",
            DatasetType = AwsNative.Personalize.DatasetType.Interactions,
            DatasetGroupArn = "arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name",
            SchemaArn = "arn:aws:personalize:us-west-2:123456789012:schema/schema-name",
            DatasetImportJob = new AwsNative.Personalize.Inputs.DatasetImportJobArgs
            {
                JobName = "my-import-job-name",
                DataSource = new AwsNative.Personalize.Inputs.DatasetImportJobDataSourcePropertiesArgs
                {
                    DataLocation = "s3://bucket-name/file-name.csv",
                },
                RoleArn = "arn:aws:iam::123456789012:role/personalize-role",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/personalize"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := personalize.NewDataset(ctx, "myDataset", &personalize.DatasetArgs{
    			Name:            pulumi.String("my-dataset-name"),
    			DatasetType:     personalize.DatasetTypeInteractions,
    			DatasetGroupArn: pulumi.String("arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name"),
    			SchemaArn:       pulumi.String("arn:aws:personalize:us-west-2:123456789012:schema/schema-name"),
    			DatasetImportJob: &personalize.DatasetImportJobArgs{
    				JobName: pulumi.String("my-import-job-name"),
    				DataSource: &personalize.DatasetImportJobDataSourcePropertiesArgs{
    					DataLocation: pulumi.String("s3://bucket-name/file-name.csv"),
    				},
    				RoleArn: pulumi.String("arn:aws:iam::123456789012:role/personalize-role"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    my_dataset = aws_native.personalize.Dataset("myDataset",
        name="my-dataset-name",
        dataset_type=aws_native.personalize.DatasetType.INTERACTIONS,
        dataset_group_arn="arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name",
        schema_arn="arn:aws:personalize:us-west-2:123456789012:schema/schema-name",
        dataset_import_job=aws_native.personalize.DatasetImportJobArgs(
            job_name="my-import-job-name",
            data_source=aws_native.personalize.DatasetImportJobDataSourcePropertiesArgs(
                data_location="s3://bucket-name/file-name.csv",
            ),
            role_arn="arn:aws:iam::123456789012:role/personalize-role",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const myDataset = new aws_native.personalize.Dataset("myDataset", {
        name: "my-dataset-name",
        datasetType: aws_native.personalize.DatasetType.Interactions,
        datasetGroupArn: "arn:aws:personalize:us-west-2:123456789012:dataset-group/dataset-group-name",
        schemaArn: "arn:aws:personalize:us-west-2:123456789012:schema/schema-name",
        datasetImportJob: {
            jobName: "my-import-job-name",
            dataSource: {
                dataLocation: "s3://bucket-name/file-name.csv",
            },
            roleArn: "arn:aws:iam::123456789012:role/personalize-role",
        },
    });
    

    Coming soon!

    Create Dataset Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);
    @overload
    def Dataset(resource_name: str,
                args: DatasetArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dataset(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                dataset_group_arn: Optional[str] = None,
                dataset_type: Optional[DatasetType] = None,
                schema_arn: Optional[str] = None,
                dataset_import_job: Optional[DatasetImportJobArgs] = None,
                name: Optional[str] = None)
    func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)
    public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)
    public Dataset(String name, DatasetArgs args)
    public Dataset(String name, DatasetArgs args, CustomResourceOptions options)
    
    type: aws-native:personalize:Dataset
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DatasetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatasetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatasetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatasetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatasetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampledatasetResourceResourceFromPersonalize = new aws_native.personalize.Dataset("exampledatasetResourceResourceFromPersonalize", {
        datasetGroupArn: "string",
        datasetType: aws_native.personalize.DatasetType.Interactions,
        schemaArn: "string",
        datasetImportJob: {
            dataSource: {
                dataLocation: "string",
            },
            datasetArn: "string",
            datasetImportJobArn: "string",
            jobName: "string",
            roleArn: "string",
        },
        name: "string",
    });
    
    Coming soon!
    

    Dataset Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Dataset resource accepts the following input properties:

    DatasetGroupArn string
    The Amazon Resource Name (ARN) of the dataset group to add the dataset to
    DatasetType Pulumi.AwsNative.Personalize.DatasetType
    The type of dataset
    SchemaArn string
    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
    DatasetImportJob Pulumi.AwsNative.Personalize.Inputs.DatasetImportJob
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. If you specify a dataset import job as part of a dataset, all dataset import job fields are required.
    Name string
    The name for the dataset
    DatasetGroupArn string
    The Amazon Resource Name (ARN) of the dataset group to add the dataset to
    DatasetType DatasetType
    The type of dataset
    SchemaArn string
    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
    DatasetImportJob DatasetImportJobArgs
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. If you specify a dataset import job as part of a dataset, all dataset import job fields are required.
    Name string
    The name for the dataset
    datasetGroupArn String
    The Amazon Resource Name (ARN) of the dataset group to add the dataset to
    datasetType DatasetType
    The type of dataset
    schemaArn String
    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
    datasetImportJob DatasetImportJob
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. If you specify a dataset import job as part of a dataset, all dataset import job fields are required.
    name String
    The name for the dataset
    datasetGroupArn string
    The Amazon Resource Name (ARN) of the dataset group to add the dataset to
    datasetType DatasetType
    The type of dataset
    schemaArn string
    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
    datasetImportJob DatasetImportJob
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. If you specify a dataset import job as part of a dataset, all dataset import job fields are required.
    name string
    The name for the dataset
    dataset_group_arn str
    The Amazon Resource Name (ARN) of the dataset group to add the dataset to
    dataset_type DatasetType
    The type of dataset
    schema_arn str
    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
    dataset_import_job DatasetImportJobArgs
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. If you specify a dataset import job as part of a dataset, all dataset import job fields are required.
    name str
    The name for the dataset
    datasetGroupArn String
    The Amazon Resource Name (ARN) of the dataset group to add the dataset to
    datasetType "Interactions" | "Items" | "Users"
    The type of dataset
    schemaArn String
    The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
    datasetImportJob Property Map
    Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. If you specify a dataset import job as part of a dataset, all dataset import job fields are required.
    name String
    The name for the dataset

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Dataset resource produces the following output properties:

    DatasetArn string
    The ARN of the dataset
    Id string
    The provider-assigned unique ID for this managed resource.
    DatasetArn string
    The ARN of the dataset
    Id string
    The provider-assigned unique ID for this managed resource.
    datasetArn String
    The ARN of the dataset
    id String
    The provider-assigned unique ID for this managed resource.
    datasetArn string
    The ARN of the dataset
    id string
    The provider-assigned unique ID for this managed resource.
    dataset_arn str
    The ARN of the dataset
    id str
    The provider-assigned unique ID for this managed resource.
    datasetArn String
    The ARN of the dataset
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DatasetImportJob, DatasetImportJobArgs

    DataSource Pulumi.AwsNative.Personalize.Inputs.DatasetImportJobDataSourceProperties
    The Amazon S3 bucket that contains the training data to import.
    DatasetArn string
    The ARN of the dataset that receives the imported data
    DatasetImportJobArn string
    The ARN of the dataset import job
    JobName string
    The name for the dataset import job.
    RoleArn string
    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
    DataSource DatasetImportJobDataSourceProperties
    The Amazon S3 bucket that contains the training data to import.
    DatasetArn string
    The ARN of the dataset that receives the imported data
    DatasetImportJobArn string
    The ARN of the dataset import job
    JobName string
    The name for the dataset import job.
    RoleArn string
    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
    dataSource DatasetImportJobDataSourceProperties
    The Amazon S3 bucket that contains the training data to import.
    datasetArn String
    The ARN of the dataset that receives the imported data
    datasetImportJobArn String
    The ARN of the dataset import job
    jobName String
    The name for the dataset import job.
    roleArn String
    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
    dataSource DatasetImportJobDataSourceProperties
    The Amazon S3 bucket that contains the training data to import.
    datasetArn string
    The ARN of the dataset that receives the imported data
    datasetImportJobArn string
    The ARN of the dataset import job
    jobName string
    The name for the dataset import job.
    roleArn string
    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
    data_source DatasetImportJobDataSourceProperties
    The Amazon S3 bucket that contains the training data to import.
    dataset_arn str
    The ARN of the dataset that receives the imported data
    dataset_import_job_arn str
    The ARN of the dataset import job
    job_name str
    The name for the dataset import job.
    role_arn str
    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
    dataSource Property Map
    The Amazon S3 bucket that contains the training data to import.
    datasetArn String
    The ARN of the dataset that receives the imported data
    datasetImportJobArn String
    The ARN of the dataset import job
    jobName String
    The name for the dataset import job.
    roleArn String
    The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

    DatasetImportJobDataSourceProperties, DatasetImportJobDataSourcePropertiesArgs

    DataLocation string
    The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.
    DataLocation string
    The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.
    dataLocation String
    The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.
    dataLocation string
    The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.
    data_location str
    The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.
    dataLocation String
    The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored.

    DatasetType, DatasetTypeArgs

    Interactions
    Interactions
    Items
    Items
    Users
    Users
    DatasetTypeInteractions
    Interactions
    DatasetTypeItems
    Items
    DatasetTypeUsers
    Users
    Interactions
    Interactions
    Items
    Items
    Users
    Users
    Interactions
    Interactions
    Items
    Items
    Users
    Users
    INTERACTIONS
    Interactions
    ITEMS
    Items
    USERS
    Users
    "Interactions"
    Interactions
    "Items"
    Items
    "Users"
    Users

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi