Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. forecast
  5. getDataset

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.forecast.getDataset

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type Definition for AWS::Forecast::Dataset

    Using getDataset

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>
    def get_dataset(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDatasetResult
def get_dataset_output(arn: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
    func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput

    > Note: This function is named LookupDataset in the Go SDK.

    public static class GetDataset 
{
    public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
    public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:forecast:getDataset
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the dataset.
    Arn string
    The Amazon Resource Name (ARN) of the dataset.
    arn String
    The Amazon Resource Name (ARN) of the dataset.
    arn string
    The Amazon Resource Name (ARN) of the dataset.
    arn str
    The Amazon Resource Name (ARN) of the dataset.
    arn String
    The Amazon Resource Name (ARN) of the dataset.

    getDataset Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the dataset.
    DataFrequency string
    Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
    DatasetType Pulumi.AwsNative.Forecast.DatasetType
    The dataset type
    Domain Pulumi.AwsNative.Forecast.DatasetDomain
    The domain associated with the dataset
    EncryptionConfig Pulumi.AwsNative.Forecast.Outputs.EncryptionConfigProperties
    A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    Schema Pulumi.AwsNative.Forecast.Outputs.SchemaProperties
    The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
    Tags List<Pulumi.AwsNative.Outputs.Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    Arn string
    The Amazon Resource Name (ARN) of the dataset.
    DataFrequency string
    Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
    DatasetType DatasetType
    The dataset type
    Domain DatasetDomain
    The domain associated with the dataset
    EncryptionConfig EncryptionConfigProperties
    A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    Schema SchemaProperties
    The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
    Tags Tag

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    arn String
    The Amazon Resource Name (ARN) of the dataset.
    dataFrequency String
    Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
    datasetType DatasetType
    The dataset type
    domain DatasetDomain
    The domain associated with the dataset
    encryptionConfig EncryptionConfigProperties
    A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    schema SchemaProperties
    The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
    tags List<Tag>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    arn string
    The Amazon Resource Name (ARN) of the dataset.
    dataFrequency string
    Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
    datasetType DatasetType
    The dataset type
    domain DatasetDomain
    The domain associated with the dataset
    encryptionConfig EncryptionConfigProperties
    A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    schema SchemaProperties
    The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
    tags Tag[]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    arn str
    The Amazon Resource Name (ARN) of the dataset.
    data_frequency str
    Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
    dataset_type DatasetType
    The dataset type
    domain DatasetDomain
    The domain associated with the dataset
    encryption_config EncryptionConfigProperties
    A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    schema SchemaProperties
    The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
    tags Sequence[root_Tag]

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    arn String
    The Amazon Resource Name (ARN) of the dataset.
    dataFrequency String
    Frequency of data collection. This parameter is required for RELATED_TIME_SERIES
    datasetType "TARGET_TIME_SERIES" | "RELATED_TIME_SERIES" | "ITEM_METADATA"
    The dataset type
    domain "RETAIL" | "CUSTOM" | "INVENTORY_PLANNING" | "EC2_CAPACITY" | "WORK_FORCE" | "WEB_TRAFFIC" | "METRICS"
    The domain associated with the dataset
    encryptionConfig Property Map
    A Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    schema Property Map
    The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see Dataset Domains and Dataset Types .
    tags List<Property Map>

    An array of key-value pairs to apply to this resource.

    For more information, see Tag .

    Supporting Types

    DatasetAttributesItemProperties

    AttributeName string
    Name of the dataset field
    AttributeType DatasetAttributesItemPropertiesAttributeType
    Data type of the field
    attributeName String
    Name of the dataset field
    attributeType DatasetAttributesItemPropertiesAttributeType
    Data type of the field
    attributeName string
    Name of the dataset field
    attributeType DatasetAttributesItemPropertiesAttributeType
    Data type of the field
    attribute_name str
    Name of the dataset field
    attribute_type DatasetAttributesItemPropertiesAttributeType
    Data type of the field

    DatasetAttributesItemPropertiesAttributeType

    DatasetDomain

    DatasetType

    EncryptionConfigProperties

    KmsKeyArn string
    The Amazon Resource Name (ARN) of the KMS key.
    RoleArn string

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    KmsKeyArn string
    The Amazon Resource Name (ARN) of the KMS key.
    RoleArn string

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    kmsKeyArn String
    The Amazon Resource Name (ARN) of the KMS key.
    roleArn String

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    kmsKeyArn string
    The Amazon Resource Name (ARN) of the KMS key.
    roleArn string

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    kms_key_arn str
    The Amazon Resource Name (ARN) of the KMS key.
    role_arn str

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    kmsKeyArn String
    The Amazon Resource Name (ARN) of the KMS key.
    roleArn String

    The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

    Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

    SchemaProperties

    Attributes List<Pulumi.AwsNative.Forecast.Inputs.DatasetAttributesItemProperties>
    An array of attributes specifying the name and type of each field in a dataset.
    Attributes []DatasetAttributesItemProperties
    An array of attributes specifying the name and type of each field in a dataset.
    attributes List<DatasetAttributesItemProperties>
    An array of attributes specifying the name and type of each field in a dataset.
    attributes DatasetAttributesItemProperties[]
    An array of attributes specifying the name and type of each field in a dataset.
    attributes Sequence[DatasetAttributesItemProperties]
    An array of attributes specifying the name and type of each field in a dataset.
    attributes List<Property Map>
    An array of attributes specifying the name and type of each field in a dataset.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native