# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.SecurityLake do
@moduledoc """
Amazon Security Lake is a fully managed security data lake service.
You can use Security Lake to
automatically centralize security data from cloud, on-premises, and custom
sources into a
data lake that's stored in your Amazon Web Services account. Amazon Web Services
Organizations
is an account management service that lets you consolidate multiple Amazon Web
Services
accounts into an organization that you create and centrally manage. With
Organizations, you
can create member accounts and invite existing accounts to join your
organization.
Security Lake helps you analyze security data for a more complete understanding
of your
security posture across the entire organization. It can also help you improve
the
protection of your workloads, applications, and data.
The data lake is backed by Amazon Simple Storage Service (Amazon S3) buckets,
and you
retain ownership over your data.
Amazon Security Lake integrates with CloudTrail, a service that provides a
record of
actions taken by a user, role, or an Amazon Web Services service. In Security
Lake, CloudTrail captures API calls for Security Lake as events. The calls
captured include calls
from the Security Lake console and code calls to the Security Lake API
operations. If you create a
trail, you can enable continuous delivery of CloudTrail events to an Amazon S3
bucket, including events for Security Lake. If you don't configure a trail, you
can still
view the most recent events in the CloudTrail console in Event history. Using
the
information collected by CloudTrail you can determine the request that was made
to
Security Lake, the IP address from which the request was made, who made the
request, when it
was made, and additional details. To learn more about Security Lake information
in CloudTrail, see the [Amazon Security Lake User Guide](https://docs.aws.amazon.com/security-lake/latest/userguide/securitylake-cloudtrail.html).
Security Lake automates the collection of security-related log and event data
from
integrated Amazon Web Services services and third-party services. It also helps
you manage
the lifecycle of data with customizable retention and replication settings.
Security Lake
converts ingested data into Apache Parquet format and a standard open-source
schema called
the Open Cybersecurity Schema Framework (OCSF).
Other Amazon Web Services services and third-party services can subscribe to the
data that's stored in Security Lake for
incident response and security data analytics.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
list_subscribers_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_subscribers_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_lake_response() :: %{}
"""
@type delete_data_lake_response() :: %{}
@typedoc """
## Example:
get_subscriber_request() :: %{}
"""
@type get_subscriber_request() :: %{}
@typedoc """
## Example:
data_lake_replication_configuration() :: %{
"regions" => list(String.t() | atom()),
"roleArn" => String.t() | atom()
}
"""
@type data_lake_replication_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
https_notification_configuration() :: %{
"authorizationApiKeyName" => [String.t() | atom()],
"authorizationApiKeyValue" => [String.t() | atom()],
"endpoint" => [String.t() | atom()],
"httpMethod" => list(any()),
"targetRoleArn" => String.t() | atom()
}
"""
@type https_notification_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_subscriber_request() :: %{
optional("sources") => list(list()),
optional("subscriberDescription") => String.t() | atom(),
optional("subscriberIdentity") => aws_identity(),
optional("subscriberName") => String.t() | atom()
}
"""
@type update_subscriber_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_subscriber_request() :: %{}
"""
@type delete_subscriber_request() :: %{}
@typedoc """
## Example:
list_data_lake_exceptions_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("regions") => list(String.t() | atom())
}
"""
@type list_data_lake_exceptions_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => [String.t() | atom()],
"quotaCode" => [String.t() | atom()],
"retryAfterSeconds" => [integer()],
"serviceCode" => [String.t() | atom()]
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_lifecycle_configuration() :: %{
"expiration" => data_lake_lifecycle_expiration(),
"transitions" => list(data_lake_lifecycle_transition())
}
"""
@type data_lake_lifecycle_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_lifecycle_transition() :: %{
"days" => [integer()],
"storageClass" => String.t() | atom()
}
"""
@type data_lake_lifecycle_transition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_aws_log_source_request() :: %{
required("sources") => list(aws_log_source_configuration())
}
"""
@type create_aws_log_source_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_subscriber_notification_response() :: %{
"subscriberEndpoint" => String.t() | atom()
}
"""
@type create_subscriber_notification_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"errorCode" => [String.t() | atom()],
"message" => [String.t() | atom()]
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_data_lake_exception_subscription_request() :: %{
optional("exceptionTimeToLive") => [float()],
required("notificationEndpoint") => String.t() | atom(),
required("subscriptionProtocol") => String.t() | atom()
}
"""
@type update_data_lake_exception_subscription_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_data_lake_organization_configuration_response() :: %{}
"""
@type create_data_lake_organization_configuration_response() :: %{}
@typedoc """
## Example:
custom_log_source_attributes() :: %{
"crawlerArn" => String.t() | atom(),
"databaseArn" => String.t() | atom(),
"tableArn" => String.t() | atom()
}
"""
@type custom_log_source_attributes() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"key" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_log_sources_request() :: %{
optional("accounts") => list(String.t() | atom()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("regions") => list(String.t() | atom()),
optional("sources") => list(list())
}
"""
@type list_log_sources_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_data_lake_request() :: %{
optional("metaStoreManagerRoleArn") => String.t() | atom(),
required("configurations") => list(data_lake_configuration())
}
"""
@type update_data_lake_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_data_lake_exception_subscription_response() :: %{}
"""
@type update_data_lake_exception_subscription_response() :: %{}
@typedoc """
## Example:
aws_log_source_configuration() :: %{
"accounts" => list(String.t() | atom()),
"regions" => list(String.t() | atom()),
"sourceName" => list(any()),
"sourceVersion" => String.t() | atom()
}
"""
@type aws_log_source_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sqs_notification_configuration() :: %{}
"""
@type sqs_notification_configuration() :: %{}
@typedoc """
## Example:
update_subscriber_notification_request() :: %{
required("configuration") => list()
}
"""
@type update_subscriber_notification_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_resource() :: %{
"createStatus" => list(any()),
"dataLakeArn" => String.t() | atom(),
"encryptionConfiguration" => data_lake_encryption_configuration(),
"lifecycleConfiguration" => data_lake_lifecycle_configuration(),
"region" => String.t() | atom(),
"replicationConfiguration" => data_lake_replication_configuration(),
"s3BucketArn" => String.t() | atom(),
"updateStatus" => data_lake_update_status()
}
"""
@type data_lake_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_subscriber_notification_response() :: %{}
"""
@type delete_subscriber_notification_response() :: %{}
@typedoc """
## Example:
data_lake_source_status() :: %{
"resource" => [String.t() | atom()],
"status" => list(any())
}
"""
@type data_lake_source_status() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_log_source_provider() :: %{
"location" => String.t() | atom(),
"roleArn" => String.t() | atom()
}
"""
@type custom_log_source_provider() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_subscriber_response() :: %{
"subscriber" => subscriber_resource()
}
"""
@type get_subscriber_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_data_lakes_response() :: %{
"dataLakes" => list(data_lake_resource())
}
"""
@type list_data_lakes_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_aws_log_source_response() :: %{
"failed" => list(String.t() | atom())
}
"""
@type delete_aws_log_source_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_data_lake_response() :: %{
"dataLakes" => list(data_lake_resource())
}
"""
@type update_data_lake_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
aws_identity() :: %{
"externalId" => String.t() | atom(),
"principal" => String.t() | atom()
}
"""
@type aws_identity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_custom_log_source_request() :: %{
optional("eventClasses") => list(String.t() | atom()),
optional("sourceVersion") => String.t() | atom(),
required("configuration") => custom_log_source_configuration(),
required("sourceName") => String.t() | atom()
}
"""
@type create_custom_log_source_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_data_lake_exception_subscription_response() :: %{}
"""
@type create_data_lake_exception_subscription_response() :: %{}
@typedoc """
## Example:
create_custom_log_source_response() :: %{
"source" => custom_log_source_resource()
}
"""
@type create_custom_log_source_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_subscriber_request() :: %{
optional("accessTypes") => list(list(any())()),
optional("subscriberDescription") => String.t() | atom(),
optional("tags") => list(tag()),
required("sources") => list(list()),
required("subscriberIdentity") => aws_identity(),
required("subscriberName") => [String.t() | atom()]
}
"""
@type create_subscriber_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_log_sources_response() :: %{
"nextToken" => String.t() | atom(),
"sources" => list(log_source())
}
"""
@type list_log_sources_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_lake_exception_subscription_response() :: %{
"exceptionTimeToLive" => [float()],
"notificationEndpoint" => String.t() | atom(),
"subscriptionProtocol" => String.t() | atom()
}
"""
@type get_data_lake_exception_subscription_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => [String.t() | atom()],
"resourceName" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_lake_request() :: %{
required("regions") => list(String.t() | atom())
}
"""
@type delete_data_lake_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
register_data_lake_delegated_administrator_request() :: %{
required("accountId") => String.t() | atom()
}
"""
@type register_data_lake_delegated_administrator_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_lake_exception_subscription_request() :: %{}
"""
@type delete_data_lake_exception_subscription_request() :: %{}
@typedoc """
## Example:
tag_resource_request() :: %{
required("tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deregister_data_lake_delegated_administrator_request() :: %{}
"""
@type deregister_data_lake_delegated_administrator_request() :: %{}
@typedoc """
## Example:
delete_subscriber_response() :: %{}
"""
@type delete_subscriber_response() :: %{}
@typedoc """
## Example:
data_lake_source() :: %{
"account" => [String.t() | atom()],
"eventClasses" => list(String.t() | atom()),
"sourceName" => [String.t() | atom()],
"sourceStatuses" => list(data_lake_source_status())
}
"""
@type data_lake_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
create_data_lake_exception_subscription_request() :: %{
optional("exceptionTimeToLive") => [float()],
required("notificationEndpoint") => String.t() | atom(),
required("subscriptionProtocol") => String.t() | atom()
}
"""
@type create_data_lake_exception_subscription_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
log_source() :: %{
"account" => String.t() | atom(),
"region" => String.t() | atom(),
"sources" => list(list())
}
"""
@type log_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_lake_sources_request() :: %{
optional("accounts") => list(String.t() | atom()),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type get_data_lake_sources_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_lake_organization_configuration_request() :: %{}
"""
@type get_data_lake_organization_configuration_request() :: %{}
@typedoc """
## Example:
create_aws_log_source_response() :: %{
"failed" => list(String.t() | atom())
}
"""
@type create_aws_log_source_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_lake_organization_configuration_response() :: %{}
"""
@type delete_data_lake_organization_configuration_response() :: %{}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => [String.t() | atom()],
"resourceName" => [String.t() | atom()],
"resourceType" => [String.t() | atom()]
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
create_data_lake_response() :: %{
"dataLakes" => list(data_lake_resource())
}
"""
@type create_data_lake_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
aws_log_source_resource() :: %{
"sourceName" => list(any()),
"sourceVersion" => String.t() | atom()
}
"""
@type aws_log_source_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_lake_exception_subscription_request() :: %{}
"""
@type get_data_lake_exception_subscription_request() :: %{}
@typedoc """
## Example:
delete_custom_log_source_request() :: %{
optional("sourceVersion") => String.t() | atom()
}
"""
@type delete_custom_log_source_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_lake_exception_subscription_response() :: %{}
"""
@type delete_data_lake_exception_subscription_response() :: %{}
@typedoc """
## Example:
create_subscriber_notification_request() :: %{
required("configuration") => list()
}
"""
@type create_subscriber_notification_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_data_lake_exceptions_response() :: %{
"exceptions" => list(data_lake_exception()),
"nextToken" => String.t() | atom()
}
"""
@type list_data_lake_exceptions_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_subscriber_response() :: %{
"subscriber" => subscriber_resource()
}
"""
@type update_subscriber_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_subscriber_notification_request() :: %{}
"""
@type delete_subscriber_notification_request() :: %{}
@typedoc """
## Example:
update_subscriber_notification_response() :: %{
"subscriberEndpoint" => String.t() | atom()
}
"""
@type update_subscriber_notification_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_data_lake_request() :: %{
optional("tags") => list(tag()),
required("configurations") => list(data_lake_configuration()),
required("metaStoreManagerRoleArn") => String.t() | atom()
}
"""
@type create_data_lake_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_auto_enable_new_account_configuration() :: %{
"region" => String.t() | atom(),
"sources" => list(aws_log_source_resource())
}
"""
@type data_lake_auto_enable_new_account_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_update_exception() :: %{
"code" => [String.t() | atom()],
"reason" => [String.t() | atom()]
}
"""
@type data_lake_update_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_configuration() :: %{
"encryptionConfiguration" => data_lake_encryption_configuration(),
"lifecycleConfiguration" => data_lake_lifecycle_configuration(),
"region" => String.t() | atom(),
"replicationConfiguration" => data_lake_replication_configuration()
}
"""
@type data_lake_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"tags" => list(tag())
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_encryption_configuration() :: %{
"kmsKeyId" => [String.t() | atom()]
}
"""
@type data_lake_encryption_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_data_lake_organization_configuration_response() :: %{
"autoEnableNewAccount" => list(data_lake_auto_enable_new_account_configuration())
}
"""
@type get_data_lake_organization_configuration_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_update_status() :: %{
"exception" => data_lake_update_exception(),
"requestId" => [String.t() | atom()],
"status" => list(any())
}
"""
@type data_lake_update_status() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_lake_lifecycle_expiration() :: %{
"days" => [integer()]
}
"""
@type data_lake_lifecycle_expiration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_log_source_resource() :: %{
"attributes" => custom_log_source_attributes(),
"provider" => custom_log_source_provider(),
"sourceName" => String.t() | atom(),
"sourceVersion" => String.t() | atom()
}
"""
@type custom_log_source_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_data_lake_organization_configuration_request() :: %{
optional("autoEnableNewAccount") => list(data_lake_auto_enable_new_account_configuration())
}
"""
@type delete_data_lake_organization_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bad_request_exception() :: %{
"message" => [String.t() | atom()]
}
"""
@type bad_request_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_aws_log_source_request() :: %{
required("sources") => list(aws_log_source_configuration())
}
"""
@type delete_aws_log_source_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_log_source_configuration() :: %{
"crawlerConfiguration" => custom_log_source_crawler_configuration(),
"providerIdentity" => aws_identity()
}
"""
@type custom_log_source_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_subscribers_response() :: %{
"nextToken" => String.t() | atom(),
"subscribers" => list(subscriber_resource())
}
"""
@type list_subscribers_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_subscriber_response() :: %{
"subscriber" => subscriber_resource()
}
"""
@type create_subscriber_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
subscriber_resource() :: %{
"accessTypes" => list(list(any())()),
"createdAt" => [non_neg_integer()],
"resourceShareArn" => String.t() | atom(),
"resourceShareName" => String.t() | atom(),
"roleArn" => String.t() | atom(),
"s3BucketArn" => String.t() | atom(),
"sources" => list(list()),
"subscriberArn" => String.t() | atom(),
"subscriberDescription" => String.t() | atom(),
"subscriberEndpoint" => String.t() | atom(),
"subscriberId" => String.t() | atom(),
"subscriberIdentity" => aws_identity(),
"subscriberName" => String.t() | atom(),
"subscriberStatus" => list(any()),
"updatedAt" => [non_neg_integer()]
}
"""
@type subscriber_resource() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_data_lake_organization_configuration_request() :: %{
optional("autoEnableNewAccount") => list(data_lake_auto_enable_new_account_configuration())
}
"""
@type create_data_lake_organization_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deregister_data_lake_delegated_administrator_response() :: %{}
"""
@type deregister_data_lake_delegated_administrator_response() :: %{}
@typedoc """
## Example:
register_data_lake_delegated_administrator_response() :: %{}
"""
@type register_data_lake_delegated_administrator_response() :: %{}
@typedoc """
## Example:
data_lake_exception() :: %{
"exception" => String.t() | atom(),
"region" => String.t() | atom(),
"remediation" => String.t() | atom(),
"timestamp" => [non_neg_integer()]
}
"""
@type data_lake_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{}
"""
@type list_tags_for_resource_request() :: %{}
@typedoc """
## Example:
get_data_lake_sources_response() :: %{
"dataLakeArn" => String.t() | atom(),
"dataLakeSources" => list(data_lake_source()),
"nextToken" => String.t() | atom()
}
"""
@type get_data_lake_sources_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_custom_log_source_response() :: %{}
"""
@type delete_custom_log_source_response() :: %{}
@typedoc """
## Example:
list_data_lakes_request() :: %{
optional("regions") => list(String.t() | atom())
}
"""
@type list_data_lakes_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_log_source_crawler_configuration() :: %{
"roleArn" => String.t() | atom()
}
"""
@type custom_log_source_crawler_configuration() :: %{(String.t() | atom()) => any()}
@type create_aws_log_source_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type create_custom_log_source_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type create_data_lake_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type create_data_lake_exception_subscription_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type create_data_lake_organization_configuration_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type create_subscriber_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type create_subscriber_notification_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_aws_log_source_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_custom_log_source_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_data_lake_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_data_lake_exception_subscription_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_data_lake_organization_configuration_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_subscriber_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type delete_subscriber_notification_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type deregister_data_lake_delegated_administrator_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type get_data_lake_exception_subscription_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type get_data_lake_organization_configuration_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type get_data_lake_sources_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type get_subscriber_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type list_data_lake_exceptions_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type list_data_lakes_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type list_log_sources_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type list_subscribers_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type list_tags_for_resource_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type register_data_lake_delegated_administrator_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type tag_resource_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type untag_resource_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type update_data_lake_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type update_data_lake_exception_subscription_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type update_subscriber_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
@type update_subscriber_notification_errors() ::
bad_request_exception()
| conflict_exception()
| resource_not_found_exception()
| internal_server_exception()
| access_denied_exception()
| throttling_exception()
def metadata do
%{
api_version: "2018-05-10",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "securitylake",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "SecurityLake",
signature_version: "v4",
signing_name: "securitylake",
target_prefix: nil
}
end
@doc """
Adds a natively supported Amazon Web Services service as an Amazon Security Lake
source.
Enables
source types for member accounts in required Amazon Web Services Regions, based
on the
parameters you specify. You can choose any source type in any Region for either
accounts
that are part of a trusted organization or standalone accounts. Once you add an
Amazon Web Services service as a source, Security Lake starts collecting logs
and events from it.
You can use this API only to enable natively supported Amazon Web Services
services as a
source. Use `CreateCustomLogSource` to enable data collection from a custom
source.
"""
@spec create_aws_log_source(map(), create_aws_log_source_request(), list()) ::
{:ok, create_aws_log_source_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_aws_log_source_errors()}
def create_aws_log_source(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/logsources/aws"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Adds a third-party custom source in Amazon Security Lake, from the Amazon Web
Services Region
where you want to create a custom source.
Security Lake can collect logs and events from
third-party custom sources. After creating the appropriate IAM role to
invoke Glue crawler, use this API to add a custom source name in Security Lake.
This
operation creates a partition in the Amazon S3 bucket for Security Lake as the
target
location for log files from the custom source. In addition, this operation also
creates an
associated Glue table and an Glue crawler.
"""
@spec create_custom_log_source(map(), create_custom_log_source_request(), list()) ::
{:ok, create_custom_log_source_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_custom_log_source_errors()}
def create_custom_log_source(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/logsources/custom"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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 and after you create subscribers using the
`CreateSubscriber` API. 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](https://docs.aws.amazon.com/security-lake/latest/userguide/what-is-security-lake.html).
"""
@spec create_data_lake(map(), create_data_lake_request(), list()) ::
{:ok, create_data_lake_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_data_lake_errors()}
def create_data_lake(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates the specified notification subscription in Amazon Security Lake for the
organization
you specify.
The notification subscription is created for exceptions that cannot be resolved
by Security Lake automatically.
"""
@spec create_data_lake_exception_subscription(
map(),
create_data_lake_exception_subscription_request(),
list()
) ::
{:ok, create_data_lake_exception_subscription_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_data_lake_exception_subscription_errors()}
def create_data_lake_exception_subscription(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/exceptions/subscription"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Automatically enables Amazon Security Lake for new member accounts in your
organization.
Security Lake is not automatically enabled for any existing member accounts in
your
organization.
This operation merges the new data lake organization configuration with the
existing configuration for Security Lake in your organization. If you want to
create a new data lake organization configuration, you must delete the existing
one using
[DeleteDataLakeOrganizationConfiguration](https://docs.aws.amazon.com/security-lake/latest/APIReference/API_DeleteDataLakeOrganizationConfiguration.html).
"""
@spec create_data_lake_organization_configuration(
map(),
create_data_lake_organization_configuration_request(),
list()
) ::
{:ok, create_data_lake_organization_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_data_lake_organization_configuration_errors()}
def create_data_lake_organization_configuration(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/organization/configuration"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a subscriber 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.
"""
@spec create_subscriber(map(), create_subscriber_request(), list()) ::
{:ok, create_subscriber_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_subscriber_errors()}
def create_subscriber(%Client{} = client, input, options \\ []) do
url_path = "/v1/subscribers"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Notifies the subscriber when new data is written to the data lake for the
sources that
the subscriber consumes in Security Lake.
You can create only one subscriber notification per
subscriber.
"""
@spec create_subscriber_notification(
map(),
String.t() | atom(),
create_subscriber_notification_request(),
list()
) ::
{:ok, create_subscriber_notification_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_subscriber_notification_errors()}
def create_subscriber_notification(%Client{} = client, subscriber_id, input, options \\ []) do
url_path = "/v1/subscribers/#{AWS.Util.encode_uri(subscriber_id)}/notification"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a natively supported Amazon Web Services service as an Amazon Security
Lake source.
You
can remove a source for one or more Regions. When you remove the source,
Security Lake stops
collecting data from that source in the specified Regions and accounts, and
subscribers can
no longer consume new data from the source. However, subscribers can still
consume data
that Security Lake collected from the source before removal.
You can choose any source type in any Amazon Web Services Region for either
accounts that
are part of a trusted organization or standalone accounts.
"""
@spec delete_aws_log_source(map(), delete_aws_log_source_request(), list()) ::
{:ok, delete_aws_log_source_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_aws_log_source_errors()}
def delete_aws_log_source(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/logsources/aws/delete"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Removes a custom log source from Amazon Security Lake, to stop sending data from
the custom
source to Security Lake.
"""
@spec delete_custom_log_source(
map(),
String.t() | atom(),
delete_custom_log_source_request(),
list()
) ::
{:ok, delete_custom_log_source_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_custom_log_source_errors()}
def delete_custom_log_source(%Client{} = client, source_name, input, options \\ []) do
url_path = "/v1/datalake/logsources/custom/#{AWS.Util.encode_uri(source_name)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"sourceVersion", "sourceVersion"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
When you disable Amazon Security Lake from your account, Security Lake is
disabled in all Amazon Web Services Regions and it stops collecting data from
your sources.
Also, this API
automatically takes steps to remove the account from Security Lake. However,
Security Lake retains
all of your existing settings and the resources that it created in your Amazon
Web Services
account in the current Amazon Web Services Region.
The `DeleteDataLake` operation does not delete the data that is stored in
your Amazon S3 bucket, which is owned by your Amazon Web Services account. For
more
information, see the [Amazon Security Lake User Guide](https://docs.aws.amazon.com/security-lake/latest/userguide/disable-security-lake.html).
"""
@spec delete_data_lake(map(), delete_data_lake_request(), list()) ::
{:ok, delete_data_lake_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_data_lake_errors()}
def delete_data_lake(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/delete"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the specified notification subscription in Amazon Security Lake for the
organization
you specify.
"""
@spec delete_data_lake_exception_subscription(
map(),
delete_data_lake_exception_subscription_request(),
list()
) ::
{:ok, delete_data_lake_exception_subscription_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_data_lake_exception_subscription_errors()}
def delete_data_lake_exception_subscription(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/exceptions/subscription"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Turns off automatic enablement of Amazon Security Lake for member accounts that
are added to an organization in Organizations.
Only the delegated
Security Lake administrator for an organization can perform this operation. If
the delegated Security Lake administrator performs this operation, new member
accounts won't automatically contribute data to the data lake.
"""
@spec delete_data_lake_organization_configuration(
map(),
delete_data_lake_organization_configuration_request(),
list()
) ::
{:ok, delete_data_lake_organization_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_data_lake_organization_configuration_errors()}
def delete_data_lake_organization_configuration(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/organization/configuration/delete"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the subscription permission and all notification settings for accounts
that are
already enabled in Amazon Security Lake.
When you run `DeleteSubscriber`, the
subscriber will no longer consume data from Security Lake and the subscriber is
removed. This
operation deletes the subscriber and removes access to data in the current
Amazon Web Services Region.
"""
@spec delete_subscriber(map(), String.t() | atom(), delete_subscriber_request(), list()) ::
{:ok, delete_subscriber_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_subscriber_errors()}
def delete_subscriber(%Client{} = client, subscriber_id, input, options \\ []) do
url_path = "/v1/subscribers/#{AWS.Util.encode_uri(subscriber_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the specified subscription notification in Amazon Security Lake for the
organization
you specify.
"""
@spec delete_subscriber_notification(
map(),
String.t() | atom(),
delete_subscriber_notification_request(),
list()
) ::
{:ok, delete_subscriber_notification_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_subscriber_notification_errors()}
def delete_subscriber_notification(%Client{} = client, subscriber_id, input, options \\ []) do
url_path = "/v1/subscribers/#{AWS.Util.encode_uri(subscriber_id)}/notification"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes the Amazon Security Lake delegated administrator account for the
organization.
This API
can only be called by the organization management account. The organization
management
account cannot be the delegated administrator account.
"""
@spec deregister_data_lake_delegated_administrator(
map(),
deregister_data_lake_delegated_administrator_request(),
list()
) ::
{:ok, deregister_data_lake_delegated_administrator_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, deregister_data_lake_delegated_administrator_errors()}
def deregister_data_lake_delegated_administrator(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/delegate"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the protocol and endpoint that were provided when subscribing to
Amazon SNS topics for exception notifications.
"""
@spec get_data_lake_exception_subscription(map(), list()) ::
{:ok, get_data_lake_exception_subscription_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_data_lake_exception_subscription_errors()}
def get_data_lake_exception_subscription(%Client{} = client, options \\ []) do
url_path = "/v1/datalake/exceptions/subscription"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the configuration that will be automatically set up for accounts added
to the
organization after the organization has onboarded to Amazon Security Lake.
This API does not take
input parameters.
"""
@spec get_data_lake_organization_configuration(map(), list()) ::
{:ok, get_data_lake_organization_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_data_lake_organization_configuration_errors()}
def get_data_lake_organization_configuration(%Client{} = client, options \\ []) do
url_path = "/v1/datalake/organization/configuration"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a snapshot of the current Region, including whether Amazon Security
Lake is enabled
for those accounts and which sources Security Lake is collecting data from.
"""
@spec get_data_lake_sources(map(), get_data_lake_sources_request(), list()) ::
{:ok, get_data_lake_sources_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_data_lake_sources_errors()}
def get_data_lake_sources(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/sources"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the subscription information for the specified subscription ID.
You can get
information about a specific subscriber.
"""
@spec get_subscriber(map(), String.t() | atom(), list()) ::
{:ok, get_subscriber_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_subscriber_errors()}
def get_subscriber(%Client{} = client, subscriber_id, options \\ []) do
url_path = "/v1/subscribers/#{AWS.Util.encode_uri(subscriber_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the Amazon Security Lake exceptions that you can use to find the source of
problems and
fix them.
"""
@spec list_data_lake_exceptions(map(), list_data_lake_exceptions_request(), list()) ::
{:ok, list_data_lake_exceptions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_data_lake_exceptions_errors()}
def list_data_lake_exceptions(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/exceptions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Retrieves the Amazon Security Lake configuration object for the specified Amazon
Web Services Regions.
You can use this operation to determine whether
Security Lake is enabled for a Region.
"""
@spec list_data_lakes(map(), String.t() | atom() | nil, list()) ::
{:ok, list_data_lakes_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_data_lakes_errors()}
def list_data_lakes(%Client{} = client, regions \\ nil, options \\ []) do
url_path = "/v1/datalakes"
headers = []
query_params = []
query_params =
if !is_nil(regions) do
[{"regions", regions} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the log sources.
"""
@spec list_log_sources(map(), list_log_sources_request(), list()) ::
{:ok, list_log_sources_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_log_sources_errors()}
def list_log_sources(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/logsources/list"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Lists all subscribers for the specific Amazon Security Lake account ID.
You can retrieve a list
of subscriptions associated with a specific organization or Amazon Web Services
account.
"""
@spec list_subscribers(map(), String.t() | atom() | nil, String.t() | atom() | nil, list()) ::
{:ok, list_subscribers_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_subscribers_errors()}
def list_subscribers(%Client{} = client, max_results \\ nil, next_token \\ nil, options \\ []) do
url_path = "/v1/subscribers"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_tags_for_resource(map(), String.t() | atom(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, resource_arn, options \\ []) do
url_path = "/v1/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Designates the Amazon Security Lake delegated administrator account for the
organization.
This
API can only be called by the organization management account. The organization
management
account cannot be the delegated administrator account.
"""
@spec register_data_lake_delegated_administrator(
map(),
register_data_lake_delegated_administrator_request(),
list()
) ::
{:ok, register_data_lake_delegated_administrator_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, register_data_lake_delegated_administrator_errors()}
def register_data_lake_delegated_administrator(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/delegate"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/security-lake/latest/userguide/tagging-resources.html)
in the
*Amazon Security Lake User Guide*.
"""
@spec tag_resource(map(), String.t() | atom(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/v1/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec untag_resource(map(), String.t() | atom(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, resource_arn, input, options \\ []) do
url_path = "/v1/tags/#{AWS.Util.encode_uri(resource_arn)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"tagKeys", "tagKeys"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
You can use `UpdateDataLake` to specify where to store your security data, how
it should
be encrypted at rest and for how long.
You can add a [Rollup Region](https://docs.aws.amazon.com/security-lake/latest/userguide/manage-regions.html#add-rollup-region)
to consolidate data from multiple Amazon Web Services Regions, replace
default encryption (SSE-S3) with [Customer Manged Key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk),
or specify transition and expiration actions through storage [Lifecycle management](https://docs.aws.amazon.com/security-lake/latest/userguide/lifecycle-management.html).
The `UpdateDataLake` API works as an "upsert" operation that performs an insert
if the specified item or record does not exist, or an update if it
already exists. Security Lake securely stores your data at rest using Amazon Web
Services encryption solutions. For more details, see [Data protection in Amazon Security
Lake](https://docs.aws.amazon.com/security-lake/latest/userguide/data-protection.html).
For example, omitting the key `encryptionConfiguration` from a Region that is
included in an update call that currently uses KMS will leave that Region's KMS
key in
place, but specifying `encryptionConfiguration: {kmsKeyId: 'S3_MANAGED_KEY'}`
for that same Region will reset the key to `S3-managed`.
For more details about lifecycle management and how to update retention settings
for one or more Regions after enabling Security Lake, see the [Amazon Security Lake User
Guide](https://docs.aws.amazon.com/security-lake/latest/userguide/lifecycle-management.html).
"""
@spec update_data_lake(map(), update_data_lake_request(), list()) ::
{:ok, update_data_lake_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_data_lake_errors()}
def update_data_lake(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the specified notification subscription in Amazon Security Lake for the
organization
you specify.
"""
@spec update_data_lake_exception_subscription(
map(),
update_data_lake_exception_subscription_request(),
list()
) ::
{:ok, update_data_lake_exception_subscription_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_data_lake_exception_subscription_errors()}
def update_data_lake_exception_subscription(%Client{} = client, input, options \\ []) do
url_path = "/v1/datalake/exceptions/subscription"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing subscription for the given Amazon Security Lake account ID.
You can update
a subscriber by changing the sources that the subscriber consumes data from.
"""
@spec update_subscriber(map(), String.t() | atom(), update_subscriber_request(), list()) ::
{:ok, update_subscriber_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_subscriber_errors()}
def update_subscriber(%Client{} = client, subscriber_id, input, options \\ []) do
url_path = "/v1/subscribers/#{AWS.Util.encode_uri(subscriber_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing notification method for the subscription (SQS or HTTPs
endpoint) or
switches the notification subscription endpoint for a subscriber.
"""
@spec update_subscriber_notification(
map(),
String.t() | atom(),
update_subscriber_notification_request(),
list()
) ::
{:ok, update_subscriber_notification_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_subscriber_notification_errors()}
def update_subscriber_notification(%Client{} = client, subscriber_id, input, options \\ []) do
url_path = "/v1/subscribers/#{AWS.Util.encode_uri(subscriber_id)}/notification"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end