Module Awso_securitylake.ValuesSource

Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]
Sourcemodule AmazonResourceName : sig ... end
Sourcemodule RoleArn : sig ... end
Sourcemodule S3URI : sig ... end

A complete S3 URI pointing to a valid S3 object.

Sourcemodule DataLakeStorageClass : sig ... end
Sourcemodule AwsLogSourceName : sig ... end
Sourcemodule AwsLogSourceVersion : sig ... end
Sourcemodule CustomLogSourceAttributes : sig ... end

The attributes of a third-party custom source.

Sourcemodule CustomLogSourceName : sig ... end
Sourcemodule CustomLogSourceProvider : sig ... end

The details of the log provider for a third-party custom source.

Sourcemodule CustomLogSourceVersion : sig ... end

Provide transition lifecycle details of Amazon Security Lake object.

Sourcemodule Region : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule AwsLogSourceResource : sig ... end

Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services.

Sourcemodule CustomLogSourceResource : sig ... end

Amazon Security Lake can collect logs and events from third-party custom sources.

Sourcemodule SourceCollectionStatus : sig ... end

Provide expiration lifecycle details of Amazon Security Lake object.

Sourcemodule RegionList : sig ... end
Sourcemodule DataLakeStatus : sig ... end
Sourcemodule DataLakeUpdateException : sig ... end

The details of the last UpdateDataLake or DeleteDataLake API request which failed.

Sourcemodule AccessType : sig ... end
Sourcemodule AwsPrincipal : sig ... end
Sourcemodule ExternalId : sig ... end
Sourcemodule LogSourceResource : sig ... end

The supported source types from which logs and events are collected in Amazon Security Lake. For a list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.

Sourcemodule DataLakeSourceStatus : sig ... end

Retrieves the Logs status for the Amazon Security Lake account.

Sourcemodule OcsfEventClass : sig ... end
Sourcemodule AwsAccountId : sig ... end
Sourcemodule HttpMethod : sig ... end

Provides encryption details of Amazon Security Lake object.

Provides lifecycle details of Amazon Security Lake object.

Provides replication details for objects stored in the Amazon Security Lake data lake.

Sourcemodule DataLakeUpdateStatus : sig ... end

The status of the last UpdateDataLake or DeleteDataLake API request. This is set to Completed after the configuration is updated, or removed if deletion of the data lake is successful.

Sourcemodule S3BucketArn : sig ... end
Sourcemodule TagKey : sig ... end
Sourcemodule TagValue : sig ... end
Sourcemodule AccessTypeList : sig ... end
Sourcemodule AwsIdentity : sig ... end

The Amazon Web Services identity.

Sourcemodule LogSourceResourceList : sig ... end
Sourcemodule ResourceShareArn : sig ... end
Sourcemodule ResourceShareName : sig ... end
Sourcemodule SafeString : sig ... end
Sourcemodule SubscriberStatus : sig ... end
Sourcemodule UUID : sig ... end
Sourcemodule DataLakeSourceStatusList : sig ... end
Sourcemodule OcsfEventClassList : sig ... end
Sourcemodule AwsLogSourceResourceList : sig ... end
Sourcemodule AccountList : sig ... end
Sourcemodule Integer : sig ... end

The configurations used for HTTPS subscriber notification.

The configurations used for EventBridge subscriber notification.

Sourcemodule DataLakeResource : sig ... end

Provides details of Amazon Security Lake object.

Sourcemodule DataLakeConfiguration : sig ... end

Provides details of Amazon Security Lake object.

Sourcemodule Tag : sig ... end

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.

Sourcemodule SubscriberResource : sig ... end

Provides details about the Amazon Security Lake account subscription. Subscribers are notified of new objects for a source as the data is written to your Amazon S3 bucket for Security Lake.

Sourcemodule LogSource : sig ... end

Amazon Security Lake can collect logs and events from natively-supported Amazon Web Services services and custom sources.

Sourcemodule DataLakeException : sig ... end

The details for an Amazon Security Lake exception.

Sourcemodule DataLakeSource : sig ... end

Amazon Security Lake collects logs and events from supported Amazon Web Services services and custom sources. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.

Automatically enable new organization accounts as member accounts from an Amazon Security Lake administrator account.

Sourcemodule AwsLogSourceConfiguration : sig ... end

To add a natively-supported Amazon Web Services service as a log source, use these parameters to specify the configuration settings for the log source.

The configuration used for the Glue Crawler for a third-party custom source.

Sourcemodule AccessDeniedException : sig ... end

You do not have sufficient access to perform this action. Access denied errors appear when Amazon Security Lake explicitly or implicitly denies an authorization request. An explicit denial occurs when a policy contains a Deny statement for the specific Amazon Web Services action. An implicit denial occurs when there is no applicable Deny statement and also no applicable Allow statement.

Sourcemodule BadRequestException : sig ... end

The request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

Sourcemodule ConflictException : sig ... end

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

Sourcemodule InternalServerException : sig ... end

Internal service exceptions are sometimes caused by transient issues. Before you start troubleshooting, perform the operation again.

Sourcemodule ResourceNotFoundException : sig ... end

The resource could not be found.

Sourcemodule ThrottlingException : sig ... end

The limit on the number of requests per second was exceeded.

Sourcemodule DescriptionString : sig ... end
Sourcemodule NotificationConfiguration : sig ... end

Specify the configurations you want to use for subscriber notification to notify the subscriber when new data is written to the data lake for sources that the subscriber consumes in Security Lake.

Sourcemodule DataLakeResourceList : sig ... end
Sourcemodule DataLakeConfigurationList : sig ... end
Sourcemodule SubscriptionProtocol : sig ... end
Sourcemodule TagKeyList : sig ... end
Sourcemodule TagList : sig ... end
Sourcemodule NextToken : sig ... end
Sourcemodule SubscriberResourceList : sig ... end
Sourcemodule MaxResults : sig ... end
Sourcemodule LogSourceList : sig ... end
Sourcemodule DataLakeExceptionList : sig ... end
Sourcemodule DataLakeSourceList : sig ... end
Sourcemodule Long : sig ... end

The configuration used for the third-party custom source.

Sourcemodule UpdateSubscriberResponse : sig ... end

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.

Sourcemodule UpdateSubscriberRequest : sig ... end

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.

Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.

Updates an existing notification method for the subscription (SQS or HTTPs endpoint) or switches the notification subscription endpoint for a subscriber.

Sourcemodule UpdateDataLakeResponse : sig ... end

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 to consolidate data from multiple Amazon Web Services Regions, replace default encryption (SSE-S3) with Customer Manged Key, or specify transition and expiration actions through storage Lifecycle management. 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. 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.

Sourcemodule UpdateDataLakeRequest : sig ... end

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 to consolidate data from multiple Amazon Web Services Regions, replace default encryption (SSE-S3) with Customer Manged Key, or specify transition and expiration actions through storage Lifecycle management. 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. 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.

Updates the specified notification subscription in Amazon Security Lake for the organization you specify.

Updates the specified notification subscription in Amazon Security Lake for the organization you specify.

Sourcemodule UntagResourceResponse : sig ... end

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.

Sourcemodule UntagResourceRequest : sig ... end

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.

Sourcemodule TagResourceResponse : sig ... end

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.

Sourcemodule TagResourceRequest : sig ... end

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.

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.

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.

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.

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.

Sourcemodule ListSubscribersResponse : sig ... end

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.

Sourcemodule ListSubscribersRequest : sig ... end

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.

Sourcemodule ListLogSourcesResponse : sig ... end

Retrieves the log sources.

Sourcemodule ListLogSourcesRequest : sig ... end

Retrieves the log sources.

Sourcemodule ListDataLakesResponse : sig ... end

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.

Sourcemodule ListDataLakesRequest : sig ... end

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.

Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.

Lists the Amazon Security Lake exceptions that you can use to find the source of problems and fix them.

Sourcemodule GetSubscriberResponse : sig ... end

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

Sourcemodule GetSubscriberRequest : sig ... end

Retrieves the subscription information for the specified subscription ID. You can get information about a specific subscriber.

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.

Sourcemodule GetDataLakeSourcesRequest : sig ... end

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.

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.

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.

Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.

Retrieves the protocol and endpoint that were provided when subscribing to Amazon SNS topics for exception notifications.

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.

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.

Sourcemodule DeleteSubscriberResponse : sig ... end

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.

Sourcemodule DeleteSubscriberRequest : sig ... end

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.

Deletes the specified subscription notification in Amazon Security Lake for the organization you specify.

Deletes the specified subscription notification in Amazon Security Lake for the organization you specify.

Sourcemodule DeleteDataLakeResponse : sig ... end

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.

Sourcemodule DeleteDataLakeRequest : sig ... end

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.

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.

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.

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

Deletes the specified notification subscription in Amazon Security Lake for the organization you specify.

Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.

Removes a custom log source from Amazon Security Lake, to stop sending data from the custom source to Security Lake.

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.

Sourcemodule DeleteAwsLogSourceRequest : sig ... end

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.

Sourcemodule CreateSubscriberResponse : sig ... end

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.

Sourcemodule CreateSubscriberRequest : sig ... end

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.

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.

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.

Sourcemodule CreateDataLakeResponse : sig ... end

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.

Sourcemodule CreateDataLakeRequest : sig ... end

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.

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.

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.

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.

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.

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.

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.

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.

Sourcemodule CreateAwsLogSourceRequest : sig ... end

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.