Skip to content

Amazon (AWS) model

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand developing with Atlan. For that, we would suggest starting with either:

  • Snippets — small, atomic examples of single-step use cases.
  • Patterns — walkthroughs of common multi-step implementation patterns.

Base class for AWS assets.

classDiagram
    direction RL
    class AWS {
        <<abstract>>
    }
    link AWS "../aws"
    class Cloud {
        <<abstract>>
    }
    link Cloud "../entities/cloud"
    Cloud <|-- AWS : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Cloud : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Asset <|-- Catalog : extends
    class BI {
        <<abstract>>
    }
    link BI "bi"
    Catalog <|-- BI : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class ObjectStore {
        <<abstract>>
    }
    link ObjectStore "../entities/objectstore"
    Catalog <|-- ObjectStore : extends
    class S3 {
        <<abstract>>
    }
    link S3 "../s3"
    ObjectStore <|-- S3 : extends
    AWS <|-- S3 : extends
    class S3Bucket
    link S3Bucket "../entities/s3bucket"
    S3 <|-- S3Bucket : extends
    class S3Object
    link S3Object "../entities/s3object"
    S3 <|-- S3Object : extends
    class QuickSight {
        <<abstract>>
    }
    link QuickSight "../quicksight"
    BI <|-- QuickSight : extends
    class QuickSightFolder
    link QuickSightFolder "../entities/quicksightfolder"
    QuickSight <|-- QuickSightFolder : extends
    class QuickSightDashboardVisual
    link QuickSightDashboardVisual "../entities/quicksightdashboardvisual"
    QuickSight <|-- QuickSightDashboardVisual : extends
    class QuickSightAnalysisVisual
    link QuickSightAnalysisVisual "../entities/quicksightanalysisvisual"
    QuickSight <|-- QuickSightAnalysisVisual : extends
    class QuickSightDatasetField
    link QuickSightDatasetField "../entities/quicksightdatasetfield"
    QuickSight <|-- QuickSightDatasetField : extends
    class QuickSightAnalysis
    link QuickSightAnalysis "../entities/quicksightanalysis"
    QuickSight <|-- QuickSightAnalysis : extends
    class QuickSightDashboard
    link QuickSightDashboard "../entities/quicksightdashboard"
    QuickSight <|-- QuickSightDashboard : extends
    class QuickSightDataset
    link QuickSightDataset "../entities/quicksightdataset"
    QuickSight <|-- QuickSightDataset : extends

Attributes

Following are the properties that are uniquely available on AWS assets in Atlan.

awsAccountId
12-digit number that uniquely identifies an AWS account.
1
2
3
builder.awsAccountId("String0"); // (1)
aWS.getAwsAccountId(); // (2)
client.assets.select().where(AWS.AWS_ACCOUNT_ID.eq("String0")); // (3)

  1. Set the awsAccountId for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsAccountId from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsAccountId exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsArn
Amazon Resource Name (ARN) for this asset. This uniquely identifies the asset in AWS, and thus must be unique across all AWS asset instances.
1
2
3
4
builder.awsArn("String0"); // (1)
aWS.getAwsArn(); // (2)
client.assets.select().where(AWS.AWS_ARN.eq("String0")); // (3)
client.assets.select().where(AWS.AWS_ARN.match("String0")); // (4)

  1. Set the awsArn for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsArn from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsArn exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

  4. Find all assets in Atlan with their awsArn textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

awsOwnerId
Root user's ID.
1
2
3
builder.awsOwnerId("String0"); // (1)
aWS.getAwsOwnerId(); // (2)
client.assets.select().where(AWS.AWS_OWNER_ID.eq("String0")); // (3)

  1. Set the awsOwnerId for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsOwnerId from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsOwnerId exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsOwnerName
Root user's name.
1
2
3
4
builder.awsOwnerName("String0"); // (1)
aWS.getAwsOwnerName(); // (2)
client.assets.select().where(AWS.AWS_OWNER_NAME.eq("String0")); // (3)
client.assets.select().where(AWS.AWS_OWNER_NAME.match("String0")); // (4)

  1. Set the awsOwnerName for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsOwnerName from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsOwnerName exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

  4. Find all assets in Atlan with their awsOwnerName textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

awsPartition
Group of AWS region and service objects.
1
2
3
builder.awsPartition("String0"); // (1)
aWS.getAwsPartition(); // (2)
client.assets.select().where(AWS.AWS_PARTITION.eq("String0")); // (3)

  1. Set the awsPartition for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsPartition from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsPartition exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsRegion
Physical region where the data center in which the asset exists is clustered.
1
2
3
builder.awsRegion("String0"); // (1)
aWS.getAwsRegion(); // (2)
client.assets.select().where(AWS.AWS_REGION.eq("String0")); // (3)

  1. Set the awsRegion for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsRegion from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsRegion exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsResourceId
Unique resource ID assigned when a new resource is created.
1
2
3
builder.awsResourceId("String0"); // (1)
aWS.getAwsResourceId(); // (2)
client.assets.select().where(AWS.AWS_RESOURCE_ID.eq("String0")); // (3)

  1. Set the awsResourceId for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsResourceId from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsResourceId exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsService
Type of service in which the asset exists.
1
2
3
builder.awsService("String0"); // (1)
aWS.getAwsService(); // (2)
client.assets.select().where(AWS.AWS_SERVICE.eq("String0")); // (3)

  1. Set the awsService for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsService from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsService exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsTags
List of tags that have been applied to the asset in AWS.
1
2
3
4
5
builder // (1)
    .awsTag(AwsTag.builder().awsTagKey("String0").awsTagValue("String0").build())
    .awsTag(AwsTag.builder().awsTagKey("String1").awsTagValue("String1").build());
aWS.getAwsTags(); // (2)
client.assets.select().where(AWS.AWS_TAGS.eq(AwsTag.builder().awsTagKey("String0").awsTagValue("String0").build())); // (3)

  1. Set the awsTags for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the awsTags from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their awsTags exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_account_id
12-digit number that uniquely identifies an AWS account.
1
2
3
builder.aws_account_id = ...  # (1)
a_w_s.aws_account_id  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_ACCOUNT_ID.eq("String0"))  # (3)

  1. Set the aws_account_id for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_account_id from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_account_id exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_arn
Amazon Resource Name (ARN) for this asset. This uniquely identifies the asset in AWS, and thus must be unique across all AWS asset instances.
1
2
3
4
builder.aws_arn = ...  # (1)
a_w_s.aws_arn  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_ARN.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_ARN.match("String0"))  # (4)

  1. Set the aws_arn for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_arn from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_arn exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

  4. Find all assets in Atlan with their aws_arn textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

aws_owner_id
Root user's ID.
1
2
3
builder.aws_owner_id = ...  # (1)
a_w_s.aws_owner_id  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_OWNER_ID.eq("String0"))  # (3)

  1. Set the aws_owner_id for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_owner_id from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_owner_id exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_owner_name
Root user's name.
1
2
3
4
builder.aws_owner_name = ...  # (1)
a_w_s.aws_owner_name  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_OWNER_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_OWNER_NAME.match("String0"))  # (4)

  1. Set the aws_owner_name for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_owner_name from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_owner_name exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

  4. Find all assets in Atlan with their aws_owner_name textually matching the provided value.

    For more details

    For more information, see the searching section on full text queries.

aws_partition
Group of AWS region and service objects.
1
2
3
builder.aws_partition = ...  # (1)
a_w_s.aws_partition  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_PARTITION.eq("String0"))  # (3)

  1. Set the aws_partition for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_partition from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_partition exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_region
Physical region where the data center in which the asset exists is clustered.
1
2
3
builder.aws_region = ...  # (1)
a_w_s.aws_region  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_REGION.eq("String0"))  # (3)

  1. Set the aws_region for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_region from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_region exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_resource_id
Unique resource ID assigned when a new resource is created.
1
2
3
builder.aws_resource_id = ...  # (1)
a_w_s.aws_resource_id  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_RESOURCE_ID.eq("String0"))  # (3)

  1. Set the aws_resource_id for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_resource_id from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_resource_id exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_service
Type of service in which the asset exists.
1
2
3
builder.aws_service = ...  # (1)
a_w_s.aws_service  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_SERVICE.eq("String0"))  # (3)

  1. Set the aws_service for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_service from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_service exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

aws_tags
List of tags that have been applied to the asset in AWS.
1
2
3
builder.aws_tags = [...]  # (1)
a_w_s.aws_tags  # (2)
FluentSearch().where(FluentSearch.asset_type(AWS)).where(AWS.AWS_TAGS.eq("String0"))  # (3)

  1. Set the aws_tags for a AWS.

    For more details

    For more information, see the asset CRUD snippets on either creating or updating assets.

  2. Retrieve the aws_tags from a AWS.

    For more details

    For more information, see the asset CRUD snippets on retrieving assets.

  3. Find all assets in Atlan with their aws_tags exactly matching the provided value.

    For more details

    For more information, see the searching section on term queries.

awsAccountId
12-digit number that uniquely identifies an AWS account.
1
2
3
4
5
{
  "attributes": {
    "awsAccountId": "String0" // (1)
  }
}

  1. Set the awsAccountId for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsArn
Amazon Resource Name (ARN) for this asset. This uniquely identifies the asset in AWS, and thus must be unique across all AWS asset instances.
1
2
3
4
5
{
  "attributes": {
    "awsArn": "String0" // (1)
  }
}

  1. Set the awsArn for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsOwnerId
Root user's ID.
1
2
3
4
5
{
  "attributes": {
    "awsOwnerId": "String0" // (1)
  }
}

  1. Set the awsOwnerId for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsOwnerName
Root user's name.
1
2
3
4
5
{
  "attributes": {
    "awsOwnerName": "String0" // (1)
  }
}

  1. Set the awsOwnerName for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsPartition
Group of AWS region and service objects.
1
2
3
4
5
{
  "attributes": {
    "awsPartition": "String0" // (1)
  }
}

  1. Set the awsPartition for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsRegion
Physical region where the data center in which the asset exists is clustered.
1
2
3
4
5
{
  "attributes": {
    "awsRegion": "String0" // (1)
  }
}

  1. Set the awsRegion for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsResourceId
Unique resource ID assigned when a new resource is created.
1
2
3
4
5
{
  "attributes": {
    "awsResourceId": "String0" // (1)
  }
}

  1. Set the awsResourceId for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsService
Type of service in which the asset exists.
1
2
3
4
5
{
  "attributes": {
    "awsService": "String0" // (1)
  }
}

  1. Set the awsService for a AWS.

    For more details

    For more information, see the asset CRUD snippets.

awsTags
List of tags that have been applied to the asset in AWS.
1
2
3
4
5
6
7
8
{
  "attributes": {
    "awsTags": [ // (1)
      {"awsTagKey": "String0", "awsTagValue": "String0" },
      {"awsTagKey": "String1", "awsTagValue": "String1" }
    ]
  }
}

  1. Set the awsTags for a AWS.

    For more details

    For more information, see the asset CRUD snippets.