2023/07/20 - Amazon Security Lake - 3 new 2 updated api methods
Changes Adding support for Tags on Create and Resource Tagging API.
Retrieves the tags (keys and values) that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Security Lake resource to retrieve the tags for.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
(dict) --
tags (list) --
An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.
(dict) --
A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.
A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value . A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -
For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide .
key (string) --
The name of the tag. This is a general label that acts as a category for a more specific tag value ( value ).
value (string) --
The value that’s associated with the specified tag key ( key ). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value . A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide .
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.
list
[REQUIRED]
An array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
(dict) --
A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.
A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value . A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -
For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide .
key (string) -- [REQUIRED]
The name of the tag. This is a general label that acts as a category for a more specific tag value ( value ).
value (string) -- [REQUIRED]
The value that’s associated with the specified tag key ( key ). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
dict
Response Syntax
{}
Response Structure
(dict) --
Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your Amazon Web Services account in a particular Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.
list
[REQUIRED]
A list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
{'tags': [{'key': 'string', 'value': 'string'}]}
Initializes an Amazon Security Lake instance with the provided (or default) configuration. You can enable Security Lake in Amazon Web Services Regions with customized settings before enabling log collection in Regions. To specify particular Regions, configure these Regions using the configurations parameter. If you have already enabled Security Lake in a Region when you call this command, the command will update the Region if you provide new configuration parameters. If you have not already enabled Security Lake in the Region when you call this API, it will set up the data lake in the Region with the specified configurations.
When you enable Security Lake, it starts ingesting security data after the CreateAwsLogSource call. This includes ingesting security data from sources, storing data, and making data accessible to subscribers. Security Lake also enables all the existing settings and resources that it stores or maintains for your Amazon Web Services account in the current Region, including security log and event data. For more information, see the Amazon Security Lake User Guide.
See also: AWS API Documentation
Request Syntax
client.create_data_lake(
configurations=[
{
'encryptionConfiguration': {
'kmsKeyId': 'string'
},
'lifecycleConfiguration': {
'expiration': {
'days': 123
},
'transitions': [
{
'days': 123,
'storageClass': 'string'
},
]
},
'region': 'string',
'replicationConfiguration': {
'regions': [
'string',
],
'roleArn': 'string'
}
},
],
metaStoreManagerRoleArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
list
[REQUIRED]
Specify the Region or Regions that will contribute data to the rollup region.
(dict) --
Provides details of Amazon Security Lake object.
encryptionConfiguration (dict) --
Provides encryption details of Amazon Security Lake object.
kmsKeyId (string) --
The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
lifecycleConfiguration (dict) --
Provides lifecycle details of Amazon Security Lake object.
expiration (dict) --
Provides data expiration details of Amazon Security Lake object.
days (integer) --
Number of days before data expires in the Amazon Security Lake object.
transitions (list) --
Provides data storage transition details of Amazon Security Lake object.
(dict) --
Provide transition lifecycle details of Amazon Security Lake object.
days (integer) --
Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
storageClass (string) --
The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
region (string) -- [REQUIRED]
The Amazon Web Services Regions where Security Lake is automatically enabled.
replicationConfiguration (dict) --
Provides replication details of Amazon Security Lake object.
regions (list) --
Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
(string) --
roleArn (string) --
Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
string
[REQUIRED]
The Amazon Resource Name (ARN) used to create and update the Glue table. This table contains partitions generated by the ingestion and normalization of Amazon Web Services log sources and custom sources.
list
An array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
(dict) --
A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.
A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value . A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -
For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide .
key (string) -- [REQUIRED]
The name of the tag. This is a general label that acts as a category for a more specific tag value ( value ).
value (string) -- [REQUIRED]
The value that’s associated with the specified tag key ( key ). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
dict
Response Syntax
{
'dataLakes': [
{
'createStatus': 'INITIALIZED'|'PENDING'|'COMPLETED'|'FAILED',
'dataLakeArn': 'string',
'encryptionConfiguration': {
'kmsKeyId': 'string'
},
'lifecycleConfiguration': {
'expiration': {
'days': 123
},
'transitions': [
{
'days': 123,
'storageClass': 'string'
},
]
},
'region': 'string',
'replicationConfiguration': {
'regions': [
'string',
],
'roleArn': 'string'
},
's3BucketArn': 'string',
'updateStatus': {
'exception': {
'code': 'string',
'reason': 'string'
},
'requestId': 'string',
'status': 'INITIALIZED'|'PENDING'|'COMPLETED'|'FAILED'
}
},
]
}
Response Structure
(dict) --
dataLakes (list) --
The created Security Lake configuration object.
(dict) --
Provides details of Amazon Security Lake object.
createStatus (string) --
Retrieves the status of the configuration operation for an account in Amazon Security Lake.
dataLakeArn (string) --
The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
encryptionConfiguration (dict) --
Provides encryption details of Amazon Security Lake object.
kmsKeyId (string) --
The id of KMS encryption key used by Amazon Security Lake to encrypt the Security Lake object.
lifecycleConfiguration (dict) --
Provides lifecycle details of Amazon Security Lake object.
expiration (dict) --
Provides data expiration details of Amazon Security Lake object.
days (integer) --
Number of days before data expires in the Amazon Security Lake object.
transitions (list) --
Provides data storage transition details of Amazon Security Lake object.
(dict) --
Provide transition lifecycle details of Amazon Security Lake object.
days (integer) --
Number of days before data transitions to a different S3 Storage Class in the Amazon Security Lake object.
storageClass (string) --
The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
region (string) --
The Amazon Web Services Regions where Security Lake is enabled.
replicationConfiguration (dict) --
Provides replication details of Amazon Security Lake object.
regions (list) --
Replication enables automatic, asynchronous copying of objects across Amazon S3 buckets. Amazon S3 buckets that are configured for object replication can be owned by the same Amazon Web Services account or by different accounts. You can replicate objects to a single destination bucket or to multiple destination buckets. The destination buckets can be in different Amazon Web Services Regions or within the same Region as the source bucket.
Set up one or more rollup Regions by providing the Region or Regions that should contribute to the central rollup Region.
(string) --
roleArn (string) --
Replication settings for the Amazon S3 buckets. This parameter uses the Identity and Access Management (IAM) role you created that is managed by Security Lake, to ensure the replication setting is correct.
s3BucketArn (string) --
The ARN for the Amazon Security Lake Amazon S3 bucket.
updateStatus (dict) --
The status of the last UpdateDataLake or DeleteDataLake API request.
exception (dict) --
The details of the last UpdateDataLake or DeleteDataLake API request which failed.
code (string) --
The reason code for the exception of the last UpdateDataLake or DeleteDataLake API request.
reason (string) --
The reason for the exception of the last UpdateDataLake or DeleteDataLake API request.
requestId (string) --
The unique ID for the last UpdateDataLake or DeleteDataLake API request.
status (string) --
The status of the last UpdateDataLake or DeleteDataLake API request that was requested.
{'tags': [{'key': 'string', 'value': 'string'}]}
Creates a subscription permission for accounts that are already enabled in Amazon Security Lake. You can create a subscriber with access to data in the current Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
client.create_subscriber(
accessTypes=[
'LAKEFORMATION'|'S3',
],
sources=[
{
'awsLogSource': {
'sourceName': 'ROUTE53'|'VPC_FLOW'|'SH_FINDINGS'|'CLOUD_TRAIL_MGMT'|'LAMBDA_EXECUTION'|'S3_DATA',
'sourceVersion': 'string'
},
'customLogSource': {
'attributes': {
'crawlerArn': 'string',
'databaseArn': 'string',
'tableArn': 'string'
},
'provider': {
'location': 'string',
'roleArn': 'string'
},
'sourceName': 'string',
'sourceVersion': 'string'
}
},
],
subscriberDescription='string',
subscriberIdentity={
'externalId': 'string',
'principal': 'string'
},
subscriberName='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
list
The Amazon S3 or Lake Formation access type.
(string) --
list
[REQUIRED]
The supported Amazon Web Services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services.
(dict) --
The supported source types from which logs and events are collected in Amazon Security Lake. For a list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: awsLogSource, customLogSource.
awsLogSource (dict) --
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
sourceName (string) --
The name for a Amazon Web Services source. This must be a Regionally unique value.
sourceVersion (string) --
The version for a Amazon Web Services source. This must be a Regionally unique value.
customLogSource (dict) --
Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.
attributes (dict) --
The attributes of a third-party custom source.
crawlerArn (string) --
The ARN of the Glue crawler.
databaseArn (string) --
The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/* .
tableArn (string) --
The ARN of the Glue table.
provider (dict) --
The details of the log provider for a third-party custom source.
location (string) --
The location of the partition in the Amazon S3 bucket for Security Lake.
roleArn (string) --
The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.
sourceName (string) --
The name for a third-party custom source. This must be a Regionally unique value.
sourceVersion (string) --
The version for a third-party custom source. This must be a Regionally unique value.
string
The description for your subscriber account in Security Lake.
dict
[REQUIRED]
The AWS identity used to access your data.
externalId (string) -- [REQUIRED]
The external ID used to estalish trust relationship with the AWS identity.
principal (string) -- [REQUIRED]
The AWS identity principal.
string
[REQUIRED]
The name of your Security Lake subscriber account.
list
An array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
(dict) --
A tag is a label that you can define and associate with Amazon Web Services resources, including certain types of Amazon Security Lake resources. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other criteria. You can associate tags with the following types of Security Lake resources: subscribers, and the data lake configuration for your Amazon Web Services account in individual Amazon Web Services Regions.
A resource can have up to 50 tags. Each tag consists of a required tag key and an associated tag value . A tag key is a general label that acts as a category for a more specific tag value. Each tag key must be unique and it can have only one tag value. A tag value acts as a descriptor for a tag key. Tag keys and values are case sensitive. They can contain letters, numbers, spaces, or the following symbols: _ . : / = + @ -
For more information, see Tagging Amazon Security Lake resources in the Amazon Security Lake User Guide .
key (string) -- [REQUIRED]
The name of the tag. This is a general label that acts as a category for a more specific tag value ( value ).
value (string) -- [REQUIRED]
The value that’s associated with the specified tag key ( key ). This value acts as a descriptor for the tag key. A tag value cannot be null, but it can be an empty string.
dict
Response Syntax
{
'subscriber': {
'accessTypes': [
'LAKEFORMATION'|'S3',
],
'createdAt': datetime(2015, 1, 1),
'resourceShareArn': 'string',
'resourceShareName': 'string',
'roleArn': 'string',
's3BucketArn': 'string',
'sources': [
{
'awsLogSource': {
'sourceName': 'ROUTE53'|'VPC_FLOW'|'SH_FINDINGS'|'CLOUD_TRAIL_MGMT'|'LAMBDA_EXECUTION'|'S3_DATA',
'sourceVersion': 'string'
},
'customLogSource': {
'attributes': {
'crawlerArn': 'string',
'databaseArn': 'string',
'tableArn': 'string'
},
'provider': {
'location': 'string',
'roleArn': 'string'
},
'sourceName': 'string',
'sourceVersion': 'string'
}
},
],
'subscriberArn': 'string',
'subscriberDescription': 'string',
'subscriberEndpoint': 'string',
'subscriberId': 'string',
'subscriberIdentity': {
'externalId': 'string',
'principal': 'string'
},
'subscriberName': 'string',
'subscriberStatus': 'ACTIVE'|'DEACTIVATED'|'PENDING'|'READY',
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
subscriber (dict) --
Retrieve information about the subscriber created using the CreateSubscriber API.
accessTypes (list) --
You can choose to notify subscribers of new objects with an Amazon Simple Queue Service (Amazon SQS) queue or through messaging to an HTTPS endpoint provided by the subscriber.
Subscribers can consume data by directly querying Lake Formation tables in your Amazon S3 bucket through services like Amazon Athena. This subscription type is defined as LAKEFORMATION .
(string) --
createdAt (datetime) --
The date and time when the subscriber was created.
resourceShareArn (string) --
The Amazon Resource Name (ARN) which uniquely defines the AWS RAM resource share. Before accepting the RAM resource share invitation, you can view details related to the RAM resource share.
This field is available only for Lake Formation subscribers created after March 8, 2023.
resourceShareName (string) --
The name of the resource share.
roleArn (string) --
The Amazon Resource Name (ARN) specifying the role of the subscriber.
s3BucketArn (string) --
The ARN for the Amazon S3 bucket.
sources (list) --
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
(dict) --
The supported source types from which logs and events are collected in Amazon Security Lake. For a list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: awsLogSource, customLogSource. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
awsLogSource (dict) --
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
sourceName (string) --
The name for a Amazon Web Services source. This must be a Regionally unique value.
sourceVersion (string) --
The version for a Amazon Web Services source. This must be a Regionally unique value.
customLogSource (dict) --
Amazon Security Lake supports custom source types. For more information, see the Amazon Security Lake User Guide.
attributes (dict) --
The attributes of a third-party custom source.
crawlerArn (string) --
The ARN of the Glue crawler.
databaseArn (string) --
The ARN of the Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/* .
tableArn (string) --
The ARN of the Glue table.
provider (dict) --
The details of the log provider for a third-party custom source.
location (string) --
The location of the partition in the Amazon S3 bucket for Security Lake.
roleArn (string) --
The ARN of the IAM role to be used by the entity putting logs into your custom source partition. Security Lake will apply the correct access policies to this role, but you must first manually create the trust policy for this role. The IAM role name must start with the text 'Security Lake'. The IAM role must trust the logProviderAccountId to assume the role.
sourceName (string) --
The name for a third-party custom source. This must be a Regionally unique value.
sourceVersion (string) --
The version for a third-party custom source. This must be a Regionally unique value.
subscriberArn (string) --
The subscriber ARN of the Amazon Security Lake subscriber account.
subscriberDescription (string) --
The subscriber descriptions for a subscriber account. The description for a subscriber includes subscriberName , accountID , externalID , and subscriberId .
subscriberEndpoint (string) --
The subscriber endpoint to which exception messages are posted.
subscriberId (string) --
The subscriber ID of the Amazon Security Lake subscriber account.
subscriberIdentity (dict) --
The AWS identity used to access your data.
externalId (string) --
The external ID used to estalish trust relationship with the AWS identity.
principal (string) --
The AWS identity principal.
subscriberName (string) --
The name of your Amazon Security Lake subscriber account.
subscriberStatus (string) --
The subscriber status of the Amazon Security Lake subscriber account.
updatedAt (datetime) --
The date and time when the subscriber was last updated.