1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotsitewise
  5. getDataset

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.iotsitewise.getDataset

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource schema for AWS::IoTSiteWise::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>
Copy
def get_dataset(dataset_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDatasetResult
def get_dataset_output(dataset_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
Copy
func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
public static Output<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:iotsitewise:getDataset
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatasetId This property is required. string
The ID of the dataset.
DatasetId This property is required. string
The ID of the dataset.
datasetId This property is required. String
The ID of the dataset.
datasetId This property is required. string
The ID of the dataset.
dataset_id This property is required. str
The ID of the dataset.
datasetId This property is required. String
The ID of the dataset.

getDataset Result

The following output properties are available:

DatasetArn string
The ARN of the dataset.
DatasetDescription string
A description about the dataset, and its functionality.
DatasetId string
The ID of the dataset.
DatasetName string
The name of the dataset.
DatasetSource Pulumi.AwsNative.IoTSiteWise.Outputs.DatasetSource
The data source for the dataset.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
DatasetArn string
The ARN of the dataset.
DatasetDescription string
A description about the dataset, and its functionality.
DatasetId string
The ID of the dataset.
DatasetName string
The name of the dataset.
DatasetSource DatasetSource
The data source for the dataset.
Tags Tag
An array of key-value pairs to apply to this resource.
datasetArn String
The ARN of the dataset.
datasetDescription String
A description about the dataset, and its functionality.
datasetId String
The ID of the dataset.
datasetName String
The name of the dataset.
datasetSource DatasetSource
The data source for the dataset.
tags List<Tag>
An array of key-value pairs to apply to this resource.
datasetArn string
The ARN of the dataset.
datasetDescription string
A description about the dataset, and its functionality.
datasetId string
The ID of the dataset.
datasetName string
The name of the dataset.
datasetSource DatasetSource
The data source for the dataset.
tags Tag[]
An array of key-value pairs to apply to this resource.
dataset_arn str
The ARN of the dataset.
dataset_description str
A description about the dataset, and its functionality.
dataset_id str
The ID of the dataset.
dataset_name str
The name of the dataset.
dataset_source DatasetSource
The data source for the dataset.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
datasetArn String
The ARN of the dataset.
datasetDescription String
A description about the dataset, and its functionality.
datasetId String
The ID of the dataset.
datasetName String
The name of the dataset.
datasetSource Property Map
The data source for the dataset.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

DatasetKendraSourceDetail

KnowledgeBaseArn This property is required. string
The knowledgeBaseArn details for the Kendra dataset source.
RoleArn This property is required. string
The roleARN details for the Kendra dataset source.
KnowledgeBaseArn This property is required. string
The knowledgeBaseArn details for the Kendra dataset source.
RoleArn This property is required. string
The roleARN details for the Kendra dataset source.
knowledgeBaseArn This property is required. String
The knowledgeBaseArn details for the Kendra dataset source.
roleArn This property is required. String
The roleARN details for the Kendra dataset source.
knowledgeBaseArn This property is required. string
The knowledgeBaseArn details for the Kendra dataset source.
roleArn This property is required. string
The roleARN details for the Kendra dataset source.
knowledge_base_arn This property is required. str
The knowledgeBaseArn details for the Kendra dataset source.
role_arn This property is required. str
The roleARN details for the Kendra dataset source.
knowledgeBaseArn This property is required. String
The knowledgeBaseArn details for the Kendra dataset source.
roleArn This property is required. String
The roleARN details for the Kendra dataset source.

DatasetSource

SourceFormat This property is required. Pulumi.AwsNative.IoTSiteWise.DatasetSourceSourceFormat
The format of the dataset source associated with the dataset.
SourceType This property is required. Pulumi.AwsNative.IoTSiteWise.DatasetSourceSourceType
The type of data source for the dataset.
SourceDetail Pulumi.AwsNative.IoTSiteWise.Inputs.DatasetSourceDetail
The details of the dataset source associated with the dataset.
SourceFormat This property is required. DatasetSourceSourceFormat
The format of the dataset source associated with the dataset.
SourceType This property is required. DatasetSourceSourceType
The type of data source for the dataset.
SourceDetail DatasetSourceDetail
The details of the dataset source associated with the dataset.
sourceFormat This property is required. DatasetSourceSourceFormat
The format of the dataset source associated with the dataset.
sourceType This property is required. DatasetSourceSourceType
The type of data source for the dataset.
sourceDetail DatasetSourceDetail
The details of the dataset source associated with the dataset.
sourceFormat This property is required. DatasetSourceSourceFormat
The format of the dataset source associated with the dataset.
sourceType This property is required. DatasetSourceSourceType
The type of data source for the dataset.
sourceDetail DatasetSourceDetail
The details of the dataset source associated with the dataset.
source_format This property is required. DatasetSourceSourceFormat
The format of the dataset source associated with the dataset.
source_type This property is required. DatasetSourceSourceType
The type of data source for the dataset.
source_detail DatasetSourceDetail
The details of the dataset source associated with the dataset.
sourceFormat This property is required. "KNOWLEDGE_BASE"
The format of the dataset source associated with the dataset.
sourceType This property is required. "KENDRA"
The type of data source for the dataset.
sourceDetail Property Map
The details of the dataset source associated with the dataset.

DatasetSourceDetail

Kendra Pulumi.AwsNative.IoTSiteWise.Inputs.DatasetKendraSourceDetail
Contains details about the Kendra dataset source.
Kendra DatasetKendraSourceDetail
Contains details about the Kendra dataset source.
kendra DatasetKendraSourceDetail
Contains details about the Kendra dataset source.
kendra DatasetKendraSourceDetail
Contains details about the Kendra dataset source.
kendra DatasetKendraSourceDetail
Contains details about the Kendra dataset source.
kendra Property Map
Contains details about the Kendra dataset source.

DatasetSourceSourceFormat

DatasetSourceSourceType

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi