Skip to content

S3 model

Base class for S3 assets.

Reference documentation

This is reference documentation covering the entire Atlan model. It is not the best place to start when trying to understand how to manage S3 assets in Atlan. For that, we would suggest starting with the manage AWS S3 assets pattern.

classDiagram
    direction RL
    class S3 {
        <<abstract>>
    }
    link S3 "../s3"
    class ObjectStore {
        <<abstract>>
    }
    link ObjectStore "../entities/objectstore"
    ObjectStore <|-- S3 : extends
    class Catalog {
        <<abstract>>
    }
    link Catalog "../entities/catalog"
    Catalog <|-- ObjectStore : extends
    class Asset {
        <<abstract>>
    }
    link Asset "../entities/asset"
    Asset <|-- Catalog : extends
    class Referenceable {
        <<abstract>>
    }
    link Referenceable "../entities/referenceable"
    Referenceable <|-- Asset : extends
    class AWS {
        <<abstract>>
    }
    link AWS "../aws"
    AWS <|-- S3 : extends
    class Cloud {
        <<abstract>>
    }
    link Cloud "../entities/cloud"
    Cloud <|-- AWS : extends
    Asset <|-- Cloud : extends
    class S3Bucket
    link S3Bucket "../entities/s3bucket"
    S3 <|-- S3Bucket : extends
    class S3Object
    link S3Object "../entities/s3object"
    S3 <|-- S3Object : extends

Type-specific properties

Following are the properties uniquely available on S3 assets in Atlan.

s3ETag
Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata.
1
2
3
4
builder.s3ETag("String0"); // (1)
s3.getS3ETag(); // (2)
client.assets.select().where(S3.S3E_TAG.eq("String0")); // (3)
client.assets.select().where(S3.S3E_TAG.match("String0")); // (4)

  1. Set the s3ETag for a S3.

    For more details

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

  2. Retrieve the s3ETag from a S3.

    For more details

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

  3. Find all assets in Atlan with their s3ETag 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 s3ETag textually matching the provided value.

    For more details

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

s3Encryption
TBC
1
2
3
builder.s3Encryption("String0"); // (1)
s3.getS3Encryption(); // (2)
client.assets.select().where(S3.S3ENCRYPTION.eq("String0")); // (3)

  1. Set the s3Encryption for a S3.

    For more details

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

  2. Retrieve the s3Encryption from a S3.

    For more details

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

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

    For more details

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

aws_account_id
TBC
1
2
3
builder.aws_account_id = ...  # (1)
s3.aws_account_id  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_ACCOUNT_ID.eq("String0"))  # (3)

  1. Set the aws_account_id for a S3.

    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 S3.

    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
TBC
1
2
3
4
builder.aws_arn = ...  # (1)
s3.aws_arn  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_ARN.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_ARN.match("String0"))  # (4)

  1. Set the aws_arn for a S3.

    For more details

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

  2. Retrieve the aws_arn from a S3.

    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
TBC
1
2
3
builder.aws_owner_id = ...  # (1)
s3.aws_owner_id  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_OWNER_ID.eq("String0"))  # (3)

  1. Set the aws_owner_id for a S3.

    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 S3.

    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
TBC
1
2
3
4
builder.aws_owner_name = ...  # (1)
s3.aws_owner_name  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_OWNER_NAME.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_OWNER_NAME.match("String0"))  # (4)

  1. Set the aws_owner_name for a S3.

    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 S3.

    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
TBC
1
2
3
builder.aws_partition = ...  # (1)
s3.aws_partition  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_PARTITION.eq("String0"))  # (3)

  1. Set the aws_partition for a S3.

    For more details

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

  2. Retrieve the aws_partition from a S3.

    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
TBC
1
2
3
builder.aws_region = ...  # (1)
s3.aws_region  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_REGION.eq("String0"))  # (3)

  1. Set the aws_region for a S3.

    For more details

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

  2. Retrieve the aws_region from a S3.

    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
TBC
1
2
3
builder.aws_resource_id = ...  # (1)
s3.aws_resource_id  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_RESOURCE_ID.eq("String0"))  # (3)

  1. Set the aws_resource_id for a S3.

    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 S3.

    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
TBC
1
2
3
builder.aws_service = ...  # (1)
s3.aws_service  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_SERVICE.eq("String0"))  # (3)

  1. Set the aws_service for a S3.

    For more details

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

  2. Retrieve the aws_service from a S3.

    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
TBC
1
2
3
builder.aws_tags = [...]  # (1)
s3.aws_tags  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.AWS_TAGS.eq("String0"))  # (3)

  1. Set the aws_tags for a S3.

    For more details

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

  2. Retrieve the aws_tags from a S3.

    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.

s3_e_tag
TBC
1
2
3
4
builder.s3_e_tag = ...  # (1)
s3.s3_e_tag  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.S3E_TAG.eq("String0"))  # (3)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.S3E_TAG.match("String0"))  # (4)

  1. Set the s3_e_tag for a S3.

    For more details

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

  2. Retrieve the s3_e_tag from a S3.

    For more details

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

  3. Find all assets in Atlan with their s3_e_tag 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 s3_e_tag textually matching the provided value.

    For more details

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

s3_encryption
TBC
1
2
3
builder.s3_encryption = ...  # (1)
s3.s3_encryption  # (2)
FluentSearch().where(FluentSearch.asset_type(S3)).where(S3.S3ENCRYPTION.eq("String0"))  # (3)

  1. Set the s3_encryption for a S3.

    For more details

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

  2. Retrieve the s3_encryption from a S3.

    For more details

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

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

    For more details

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

s3ETag
Entity tag for the asset. An entity tag is a hash of the object and represents changes to the contents of an object only, not its metadata.
1
2
3
4
5
{
  "attributes": {
    "s3ETag": "String0" // (1)
  }
}

  1. Set the s3ETag for a S3.

    For more details

    For more information, see the asset CRUD snippets.

s3Encryption
TBC
1
2
3
4
5
{
  "attributes": {
    "s3Encryption": "String0" // (1)
  }
}

  1. Set the s3Encryption for a S3.

    For more details

    For more information, see the asset CRUD snippets.

Relationships

The following illustrates how the various S3 objects inter-relate with each other:

erDiagram
    Connection ||..o{ S3Bucket : ""
    S3Bucket ||--o{ S3Object : objects