Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Operations
- CreateAwsLogSource
- CreateCustomLogSource
- CreateDatalake
- CreateDatalakeAutoEnable
- CreateDatalakeDelegatedAdmin
- CreateDatalakeExceptionsSubscription
- CreateSubscriber
- CreateSubscriptionNotificationConfiguration
- DeleteAwsLogSource
- DeleteCustomLogSource
- DeleteDatalake
- DeleteDatalakeAutoEnable
- DeleteDatalakeDelegatedAdmin
- DeleteDatalakeExceptionsSubscription
- DeleteSubscriber
- DeleteSubscriptionNotificationConfiguration
- GetDatalake
- GetDatalakeAutoEnable
- GetDatalakeExceptionsExpiry
- GetDatalakeExceptionsSubscription
- GetDatalakeStatus
- GetSubscriber
- ListDatalakeExceptions
- ListLogSources
- ListSubscribers
- UpdateDatalake
- UpdateDatalakeExceptionsExpiry
- UpdateDatalakeExceptionsSubscription
- UpdateSubscriber
- UpdateSubscriptionNotificationConfiguration
- Types
Synopsis
- createAwsLogSource_enableAllDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text (HashMap Text [Text])))
- createAwsLogSource_enableSingleDimension :: Lens' CreateAwsLogSource (Maybe [Text])
- createAwsLogSource_enableTwoDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text [Text]))
- createAwsLogSource_inputOrder :: Lens' CreateAwsLogSource [Dimension]
- createAwsLogSourceResponse_failed :: Lens' CreateAwsLogSourceResponse (Maybe [Text])
- createAwsLogSourceResponse_processing :: Lens' CreateAwsLogSourceResponse (Maybe [Text])
- createAwsLogSourceResponse_httpStatus :: Lens' CreateAwsLogSourceResponse Int
- createCustomLogSource_customSourceName :: Lens' CreateCustomLogSource Text
- createCustomLogSource_eventClass :: Lens' CreateCustomLogSource OcsfEventClass
- createCustomLogSource_glueInvocationRoleArn :: Lens' CreateCustomLogSource Text
- createCustomLogSource_logProviderAccountId :: Lens' CreateCustomLogSource Text
- createCustomLogSourceResponse_httpStatus :: Lens' CreateCustomLogSourceResponse Int
- createCustomLogSourceResponse_customDataLocation :: Lens' CreateCustomLogSourceResponse Text
- createCustomLogSourceResponse_glueCrawlerName :: Lens' CreateCustomLogSourceResponse Text
- createCustomLogSourceResponse_glueDatabaseName :: Lens' CreateCustomLogSourceResponse Text
- createCustomLogSourceResponse_glueTableName :: Lens' CreateCustomLogSourceResponse Text
- createCustomLogSourceResponse_logProviderAccessRoleArn :: Lens' CreateCustomLogSourceResponse Text
- createDatalake_configurations :: Lens' CreateDatalake (Maybe (HashMap Region LakeConfigurationRequest))
- createDatalake_enableAll :: Lens' CreateDatalake (Maybe Bool)
- createDatalake_metaStoreManagerRoleArn :: Lens' CreateDatalake (Maybe Text)
- createDatalake_regions :: Lens' CreateDatalake (Maybe [Region])
- createDatalakeResponse_httpStatus :: Lens' CreateDatalakeResponse Int
- createDatalakeAutoEnable_configurationForNewAccounts :: Lens' CreateDatalakeAutoEnable [AutoEnableNewRegionConfiguration]
- createDatalakeAutoEnableResponse_httpStatus :: Lens' CreateDatalakeAutoEnableResponse Int
- createDatalakeDelegatedAdmin_account :: Lens' CreateDatalakeDelegatedAdmin Text
- createDatalakeDelegatedAdminResponse_httpStatus :: Lens' CreateDatalakeDelegatedAdminResponse Int
- createDatalakeExceptionsSubscription_notificationEndpoint :: Lens' CreateDatalakeExceptionsSubscription Text
- createDatalakeExceptionsSubscription_subscriptionProtocol :: Lens' CreateDatalakeExceptionsSubscription SubscriptionProtocolType
- createDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' CreateDatalakeExceptionsSubscriptionResponse Int
- createSubscriber_accessTypes :: Lens' CreateSubscriber (Maybe [AccessType])
- createSubscriber_subscriberDescription :: Lens' CreateSubscriber (Maybe Text)
- createSubscriber_accountId :: Lens' CreateSubscriber Text
- createSubscriber_externalId :: Lens' CreateSubscriber Text
- createSubscriber_sourceTypes :: Lens' CreateSubscriber [SourceType]
- createSubscriber_subscriberName :: Lens' CreateSubscriber Text
- createSubscriberResponse_roleArn :: Lens' CreateSubscriberResponse (Maybe Text)
- createSubscriberResponse_s3BucketArn :: Lens' CreateSubscriberResponse (Maybe Text)
- createSubscriberResponse_snsArn :: Lens' CreateSubscriberResponse (Maybe Text)
- createSubscriberResponse_httpStatus :: Lens' CreateSubscriberResponse Int
- createSubscriberResponse_subscriptionId :: Lens' CreateSubscriberResponse Text
- createSubscriptionNotificationConfiguration_createSqs :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Bool)
- createSubscriptionNotificationConfiguration_httpsApiKeyName :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text)
- createSubscriptionNotificationConfiguration_httpsApiKeyValue :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text)
- createSubscriptionNotificationConfiguration_httpsMethod :: Lens' CreateSubscriptionNotificationConfiguration (Maybe HttpsMethod)
- createSubscriptionNotificationConfiguration_roleArn :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text)
- createSubscriptionNotificationConfiguration_subscriptionEndpoint :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text)
- createSubscriptionNotificationConfiguration_subscriptionId :: Lens' CreateSubscriptionNotificationConfiguration Text
- createSubscriptionNotificationConfigurationResponse_queueArn :: Lens' CreateSubscriptionNotificationConfigurationResponse (Maybe Text)
- createSubscriptionNotificationConfigurationResponse_httpStatus :: Lens' CreateSubscriptionNotificationConfigurationResponse Int
- deleteAwsLogSource_disableAllDimensions :: Lens' DeleteAwsLogSource (Maybe (HashMap Text (HashMap Text [Text])))
- deleteAwsLogSource_disableSingleDimension :: Lens' DeleteAwsLogSource (Maybe [Text])
- deleteAwsLogSource_disableTwoDimensions :: Lens' DeleteAwsLogSource (Maybe (HashMap Text [Text]))
- deleteAwsLogSource_inputOrder :: Lens' DeleteAwsLogSource [Dimension]
- deleteAwsLogSourceResponse_failed :: Lens' DeleteAwsLogSourceResponse (Maybe [Text])
- deleteAwsLogSourceResponse_processing :: Lens' DeleteAwsLogSourceResponse (Maybe [Text])
- deleteAwsLogSourceResponse_httpStatus :: Lens' DeleteAwsLogSourceResponse Int
- deleteCustomLogSource_customSourceName :: Lens' DeleteCustomLogSource Text
- deleteCustomLogSourceResponse_httpStatus :: Lens' DeleteCustomLogSourceResponse Int
- deleteCustomLogSourceResponse_customDataLocation :: Lens' DeleteCustomLogSourceResponse Text
- deleteDatalakeResponse_httpStatus :: Lens' DeleteDatalakeResponse Int
- deleteDatalakeAutoEnable_removeFromConfigurationForNewAccounts :: Lens' DeleteDatalakeAutoEnable [AutoEnableNewRegionConfiguration]
- deleteDatalakeAutoEnableResponse_httpStatus :: Lens' DeleteDatalakeAutoEnableResponse Int
- deleteDatalakeDelegatedAdmin_account :: Lens' DeleteDatalakeDelegatedAdmin Text
- deleteDatalakeDelegatedAdminResponse_httpStatus :: Lens' DeleteDatalakeDelegatedAdminResponse Int
- deleteDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' DeleteDatalakeExceptionsSubscriptionResponse Int
- deleteDatalakeExceptionsSubscriptionResponse_status :: Lens' DeleteDatalakeExceptionsSubscriptionResponse Text
- deleteSubscriber_id :: Lens' DeleteSubscriber Text
- deleteSubscriberResponse_httpStatus :: Lens' DeleteSubscriberResponse Int
- deleteSubscriptionNotificationConfiguration_subscriptionId :: Lens' DeleteSubscriptionNotificationConfiguration Text
- deleteSubscriptionNotificationConfigurationResponse_httpStatus :: Lens' DeleteSubscriptionNotificationConfigurationResponse Int
- getDatalakeResponse_httpStatus :: Lens' GetDatalakeResponse Int
- getDatalakeResponse_configurations :: Lens' GetDatalakeResponse (HashMap Region LakeConfigurationResponse)
- getDatalakeAutoEnableResponse_httpStatus :: Lens' GetDatalakeAutoEnableResponse Int
- getDatalakeAutoEnableResponse_autoEnableNewAccounts :: Lens' GetDatalakeAutoEnableResponse [AutoEnableNewRegionConfiguration]
- getDatalakeExceptionsExpiryResponse_httpStatus :: Lens' GetDatalakeExceptionsExpiryResponse Int
- getDatalakeExceptionsExpiryResponse_exceptionMessageExpiry :: Lens' GetDatalakeExceptionsExpiryResponse Integer
- getDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' GetDatalakeExceptionsSubscriptionResponse Int
- getDatalakeExceptionsSubscriptionResponse_protocolAndNotificationEndpoint :: Lens' GetDatalakeExceptionsSubscriptionResponse ProtocolAndNotificationEndpoint
- getDatalakeStatus_accountSet :: Lens' GetDatalakeStatus (Maybe [Text])
- getDatalakeStatus_maxAccountResults :: Lens' GetDatalakeStatus (Maybe Int)
- getDatalakeStatus_nextToken :: Lens' GetDatalakeStatus (Maybe Text)
- getDatalakeStatusResponse_nextToken :: Lens' GetDatalakeStatusResponse (Maybe Text)
- getDatalakeStatusResponse_httpStatus :: Lens' GetDatalakeStatusResponse Int
- getDatalakeStatusResponse_accountSourcesList :: Lens' GetDatalakeStatusResponse [AccountSources]
- getSubscriber_id :: Lens' GetSubscriber Text
- getSubscriberResponse_subscriber :: Lens' GetSubscriberResponse (Maybe SubscriberResource)
- getSubscriberResponse_httpStatus :: Lens' GetSubscriberResponse Int
- listDatalakeExceptions_maxFailures :: Lens' ListDatalakeExceptions (Maybe Int)
- listDatalakeExceptions_nextToken :: Lens' ListDatalakeExceptions (Maybe Text)
- listDatalakeExceptions_regionSet :: Lens' ListDatalakeExceptions (Maybe [Region])
- listDatalakeExceptionsResponse_nextToken :: Lens' ListDatalakeExceptionsResponse (Maybe Text)
- listDatalakeExceptionsResponse_httpStatus :: Lens' ListDatalakeExceptionsResponse Int
- listDatalakeExceptionsResponse_nonRetryableFailures :: Lens' ListDatalakeExceptionsResponse [FailuresResponse]
- listLogSources_inputOrder :: Lens' ListLogSources (Maybe [Dimension])
- listLogSources_listAllDimensions :: Lens' ListLogSources (Maybe (HashMap Text (HashMap Text [Text])))
- listLogSources_listSingleDimension :: Lens' ListLogSources (Maybe [Text])
- listLogSources_listTwoDimensions :: Lens' ListLogSources (Maybe (HashMap Text [Text]))
- listLogSources_maxResults :: Lens' ListLogSources (Maybe Int)
- listLogSources_nextToken :: Lens' ListLogSources (Maybe Text)
- listLogSourcesResponse_nextToken :: Lens' ListLogSourcesResponse (Maybe Text)
- listLogSourcesResponse_httpStatus :: Lens' ListLogSourcesResponse Int
- listLogSourcesResponse_regionSourceTypesAccountsList :: Lens' ListLogSourcesResponse [HashMap Text (HashMap Text [Text])]
- listSubscribers_maxResults :: Lens' ListSubscribers (Maybe Int)
- listSubscribers_nextToken :: Lens' ListSubscribers (Maybe Text)
- listSubscribersResponse_nextToken :: Lens' ListSubscribersResponse (Maybe Text)
- listSubscribersResponse_httpStatus :: Lens' ListSubscribersResponse Int
- listSubscribersResponse_subscribers :: Lens' ListSubscribersResponse [SubscriberResource]
- updateDatalake_configurations :: Lens' UpdateDatalake (HashMap Region LakeConfigurationRequest)
- updateDatalakeResponse_httpStatus :: Lens' UpdateDatalakeResponse Int
- updateDatalakeExceptionsExpiry_exceptionMessageExpiry :: Lens' UpdateDatalakeExceptionsExpiry Natural
- updateDatalakeExceptionsExpiryResponse_httpStatus :: Lens' UpdateDatalakeExceptionsExpiryResponse Int
- updateDatalakeExceptionsSubscription_notificationEndpoint :: Lens' UpdateDatalakeExceptionsSubscription Text
- updateDatalakeExceptionsSubscription_subscriptionProtocol :: Lens' UpdateDatalakeExceptionsSubscription SubscriptionProtocolType
- updateDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' UpdateDatalakeExceptionsSubscriptionResponse Int
- updateSubscriber_externalId :: Lens' UpdateSubscriber (Maybe Text)
- updateSubscriber_subscriberDescription :: Lens' UpdateSubscriber (Maybe Text)
- updateSubscriber_subscriberName :: Lens' UpdateSubscriber (Maybe Text)
- updateSubscriber_id :: Lens' UpdateSubscriber Text
- updateSubscriber_sourceTypes :: Lens' UpdateSubscriber [SourceType]
- updateSubscriberResponse_subscriber :: Lens' UpdateSubscriberResponse (Maybe SubscriberResource)
- updateSubscriberResponse_httpStatus :: Lens' UpdateSubscriberResponse Int
- updateSubscriptionNotificationConfiguration_createSqs :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Bool)
- updateSubscriptionNotificationConfiguration_httpsApiKeyName :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text)
- updateSubscriptionNotificationConfiguration_httpsApiKeyValue :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text)
- updateSubscriptionNotificationConfiguration_httpsMethod :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe HttpsMethod)
- updateSubscriptionNotificationConfiguration_roleArn :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text)
- updateSubscriptionNotificationConfiguration_subscriptionEndpoint :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text)
- updateSubscriptionNotificationConfiguration_subscriptionId :: Lens' UpdateSubscriptionNotificationConfiguration Text
- updateSubscriptionNotificationConfigurationResponse_queueArn :: Lens' UpdateSubscriptionNotificationConfigurationResponse (Maybe Text)
- updateSubscriptionNotificationConfigurationResponse_httpStatus :: Lens' UpdateSubscriptionNotificationConfigurationResponse Int
- accountSources_eventClass :: Lens' AccountSources (Maybe OcsfEventClass)
- accountSources_logsStatus :: Lens' AccountSources (Maybe [LogsStatus])
- accountSources_account :: Lens' AccountSources Text
- accountSources_sourceType :: Lens' AccountSources Text
- autoEnableNewRegionConfiguration_region :: Lens' AutoEnableNewRegionConfiguration Region
- autoEnableNewRegionConfiguration_sources :: Lens' AutoEnableNewRegionConfiguration [AwsLogSourceType]
- failures_exceptionMessage :: Lens' Failures Text
- failures_remediation :: Lens' Failures Text
- failures_timestamp :: Lens' Failures UTCTime
- failuresResponse_failures :: Lens' FailuresResponse (Maybe [Failures])
- failuresResponse_region :: Lens' FailuresResponse (Maybe Text)
- lakeConfigurationRequest_encryptionKey :: Lens' LakeConfigurationRequest (Maybe Text)
- lakeConfigurationRequest_replicationDestinationRegions :: Lens' LakeConfigurationRequest (Maybe [Region])
- lakeConfigurationRequest_replicationRoleArn :: Lens' LakeConfigurationRequest (Maybe Text)
- lakeConfigurationRequest_retentionSettings :: Lens' LakeConfigurationRequest (Maybe [RetentionSetting])
- lakeConfigurationRequest_tagsMap :: Lens' LakeConfigurationRequest (Maybe (HashMap Text Text))
- lakeConfigurationResponse_encryptionKey :: Lens' LakeConfigurationResponse (Maybe Text)
- lakeConfigurationResponse_replicationDestinationRegions :: Lens' LakeConfigurationResponse (Maybe [Region])
- lakeConfigurationResponse_replicationRoleArn :: Lens' LakeConfigurationResponse (Maybe Text)
- lakeConfigurationResponse_retentionSettings :: Lens' LakeConfigurationResponse (Maybe [RetentionSetting])
- lakeConfigurationResponse_s3BucketArn :: Lens' LakeConfigurationResponse (Maybe Text)
- lakeConfigurationResponse_status :: Lens' LakeConfigurationResponse (Maybe SettingsStatus)
- lakeConfigurationResponse_tagsMap :: Lens' LakeConfigurationResponse (Maybe (HashMap Text Text))
- logsStatus_healthStatus :: Lens' LogsStatus SourceStatus
- logsStatus_pathToLogs :: Lens' LogsStatus Text
- protocolAndNotificationEndpoint_endpoint :: Lens' ProtocolAndNotificationEndpoint (Maybe Text)
- protocolAndNotificationEndpoint_protocol :: Lens' ProtocolAndNotificationEndpoint (Maybe Text)
- retentionSetting_retentionPeriod :: Lens' RetentionSetting (Maybe Natural)
- retentionSetting_storageClass :: Lens' RetentionSetting (Maybe StorageClass)
- sourceType_awsSourceType :: Lens' SourceType (Maybe AwsLogSourceType)
- sourceType_customSourceType :: Lens' SourceType (Maybe Text)
- subscriberResource_accessTypes :: Lens' SubscriberResource (Maybe [AccessType])
- subscriberResource_createdAt :: Lens' SubscriberResource (Maybe UTCTime)
- subscriberResource_externalId :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_roleArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_s3BucketArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_snsArn :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriberDescription :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriberName :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriptionEndpoint :: Lens' SubscriberResource (Maybe Text)
- subscriberResource_subscriptionProtocol :: Lens' SubscriberResource (Maybe EndpointProtocol)
- subscriberResource_subscriptionStatus :: Lens' SubscriberResource (Maybe SubscriptionStatus)
- subscriberResource_updatedAt :: Lens' SubscriberResource (Maybe UTCTime)
- subscriberResource_accountId :: Lens' SubscriberResource Text
- subscriberResource_sourceTypes :: Lens' SubscriberResource [SourceType]
- subscriberResource_subscriptionId :: Lens' SubscriberResource Text
Operations
CreateAwsLogSource
createAwsLogSource_enableAllDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text (HashMap Text [Text]))) Source #
Enables data collection from specific Amazon Web Services sources in all specific accounts and specific Regions.
createAwsLogSource_enableSingleDimension :: Lens' CreateAwsLogSource (Maybe [Text]) Source #
Enables data collection from all Amazon Web Services sources in specific accounts or Regions.
createAwsLogSource_enableTwoDimensions :: Lens' CreateAwsLogSource (Maybe (HashMap Text [Text])) Source #
Enables data collection from specific Amazon Web Services sources in specific accounts or Regions.
createAwsLogSource_inputOrder :: Lens' CreateAwsLogSource [Dimension] Source #
Specifies the input order to enable dimensions in Security Lake, namely Region, source type, and member account.
createAwsLogSourceResponse_failed :: Lens' CreateAwsLogSourceResponse (Maybe [Text]) Source #
Lists all accounts in which enabling a natively supported Amazon Web Service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
createAwsLogSourceResponse_processing :: Lens' CreateAwsLogSourceResponse (Maybe [Text]) Source #
Lists the accounts that are in the process of enabling a natively supported Amazon Web Service as a Security Lake source.
createAwsLogSourceResponse_httpStatus :: Lens' CreateAwsLogSourceResponse Int Source #
The response's http status code.
CreateCustomLogSource
createCustomLogSource_customSourceName :: Lens' CreateCustomLogSource Text Source #
The name for a third-party custom source. This must be a Regionally unique value.
createCustomLogSource_eventClass :: Lens' CreateCustomLogSource OcsfEventClass Source #
The Open Cybersecurity Schema Framework (OCSF) event class which describes the type of data that the custom source will send to Security Lake.
createCustomLogSource_glueInvocationRoleArn :: Lens' CreateCustomLogSource Text Source #
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be used by the Glue crawler. The recommended IAM policies are:
- The managed policy
AWSGlueServiceRole
- A custom policy granting access to your Amazon S3 Data Lake
createCustomLogSource_logProviderAccountId :: Lens' CreateCustomLogSource Text Source #
The Amazon Web Services account ID of the custom source that will write logs and events into the Amazon S3 Data Lake.
createCustomLogSourceResponse_httpStatus :: Lens' CreateCustomLogSourceResponse Int Source #
The response's http status code.
createCustomLogSourceResponse_customDataLocation :: Lens' CreateCustomLogSourceResponse Text Source #
The location of the partition in the Amazon S3 bucket for Security Lake.
createCustomLogSourceResponse_glueCrawlerName :: Lens' CreateCustomLogSourceResponse Text Source #
The name of the Glue crawler.
createCustomLogSourceResponse_glueDatabaseName :: Lens' CreateCustomLogSourceResponse Text Source #
The Glue database where results are written, such as:
arn:aws:daylight:us-east-1::database/sometable/*
.
createCustomLogSourceResponse_glueTableName :: Lens' CreateCustomLogSourceResponse Text Source #
The table name of the Glue crawler.
createCustomLogSourceResponse_logProviderAccessRoleArn :: Lens' CreateCustomLogSourceResponse Text Source #
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.
CreateDatalake
createDatalake_configurations :: Lens' CreateDatalake (Maybe (HashMap Region LakeConfigurationRequest)) Source #
Specify the Region or Regions that will contribute data to the rollup region.
createDatalake_enableAll :: Lens' CreateDatalake (Maybe Bool) Source #
Enable Security Lake in all Regions.
createDatalake_metaStoreManagerRoleArn :: Lens' CreateDatalake (Maybe Text) Source #
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.
createDatalake_regions :: Lens' CreateDatalake (Maybe [Region]) Source #
Enable Security Lake in the specified Regions. To enable Security Lake in specific Amazon Web Services Regions, such as us-east-1 or ap-northeast-3, provide the Region codes. For a list of Region codes, see Amazon Security Lake endpoints in the Amazon Web Services General Reference.
createDatalakeResponse_httpStatus :: Lens' CreateDatalakeResponse Int Source #
The response's http status code.
CreateDatalakeAutoEnable
createDatalakeAutoEnable_configurationForNewAccounts :: Lens' CreateDatalakeAutoEnable [AutoEnableNewRegionConfiguration] Source #
Enable Security Lake with the specified configuration settings to begin collecting security data for new accounts in your organization.
createDatalakeAutoEnableResponse_httpStatus :: Lens' CreateDatalakeAutoEnableResponse Int Source #
The response's http status code.
CreateDatalakeDelegatedAdmin
createDatalakeDelegatedAdmin_account :: Lens' CreateDatalakeDelegatedAdmin Text Source #
The Amazon Web Services account ID of the Security Lake delegated administrator.
createDatalakeDelegatedAdminResponse_httpStatus :: Lens' CreateDatalakeDelegatedAdminResponse Int Source #
The response's http status code.
CreateDatalakeExceptionsSubscription
createDatalakeExceptionsSubscription_notificationEndpoint :: Lens' CreateDatalakeExceptionsSubscription Text Source #
The Amazon Web Services account where you want to receive exception notifications.
createDatalakeExceptionsSubscription_subscriptionProtocol :: Lens' CreateDatalakeExceptionsSubscription SubscriptionProtocolType Source #
The subscription protocol to which exception notifications are posted.
createDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' CreateDatalakeExceptionsSubscriptionResponse Int Source #
The response's http status code.
CreateSubscriber
createSubscriber_accessTypes :: Lens' CreateSubscriber (Maybe [AccessType]) Source #
The Amazon S3 or Lake Formation access type.
createSubscriber_subscriberDescription :: Lens' CreateSubscriber (Maybe Text) Source #
The description for your subscriber account in Security Lake.
createSubscriber_accountId :: Lens' CreateSubscriber Text Source #
The Amazon Web Services account ID used to access your data.
createSubscriber_externalId :: Lens' CreateSubscriber Text Source #
The external ID of the subscriber. This lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.
createSubscriber_sourceTypes :: Lens' CreateSubscriber [SourceType] Source #
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.
createSubscriber_subscriberName :: Lens' CreateSubscriber Text Source #
The name of your Security Lake subscriber account.
createSubscriberResponse_roleArn :: Lens' CreateSubscriberResponse (Maybe Text) Source #
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 IAM identifiers in the Identity and Access Management (IAM) User Guide. .
createSubscriberResponse_s3BucketArn :: Lens' CreateSubscriberResponse (Maybe Text) Source #
The ARN for the Amazon S3 bucket.
createSubscriberResponse_snsArn :: Lens' CreateSubscriberResponse (Maybe Text) Source #
The ARN for the Amazon Simple Notification Service.
createSubscriberResponse_httpStatus :: Lens' CreateSubscriberResponse Int Source #
The response's http status code.
createSubscriberResponse_subscriptionId :: Lens' CreateSubscriberResponse Text Source #
The subscriptionId
created by the CreateSubscriber
API call.
CreateSubscriptionNotificationConfiguration
createSubscriptionNotificationConfiguration_createSqs :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Bool) Source #
Create an Amazon Simple Queue Service queue.
createSubscriptionNotificationConfiguration_httpsApiKeyName :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text) Source #
The key name for the notification subscription.
createSubscriptionNotificationConfiguration_httpsApiKeyValue :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text) Source #
The key value for the notification subscription.
createSubscriptionNotificationConfiguration_httpsMethod :: Lens' CreateSubscriptionNotificationConfiguration (Maybe HttpsMethod) Source #
The HTTPS method used for the notification subscription.
createSubscriptionNotificationConfiguration_roleArn :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the EventBridge API destinations IAM role that you created.
createSubscriptionNotificationConfiguration_subscriptionEndpoint :: Lens' CreateSubscriptionNotificationConfiguration (Maybe Text) Source #
The subscription endpoint in Security Lake. If you prefer notification with an HTTPs endpoint, populate this field.
createSubscriptionNotificationConfiguration_subscriptionId :: Lens' CreateSubscriptionNotificationConfiguration Text Source #
The subscription ID for the notification subscription/
createSubscriptionNotificationConfigurationResponse_queueArn :: Lens' CreateSubscriptionNotificationConfigurationResponse (Maybe Text) Source #
Returns the Amazon Resource Name (ARN) of the queue.
createSubscriptionNotificationConfigurationResponse_httpStatus :: Lens' CreateSubscriptionNotificationConfigurationResponse Int Source #
The response's http status code.
DeleteAwsLogSource
deleteAwsLogSource_disableAllDimensions :: Lens' DeleteAwsLogSource (Maybe (HashMap Text (HashMap Text [Text]))) Source #
Removes the specific Amazon Web Services sources from specific accounts and specific Regions.
deleteAwsLogSource_disableSingleDimension :: Lens' DeleteAwsLogSource (Maybe [Text]) Source #
Removes all Amazon Web Services sources from specific accounts or Regions.
deleteAwsLogSource_disableTwoDimensions :: Lens' DeleteAwsLogSource (Maybe (HashMap Text [Text])) Source #
Remove a specific Amazon Web Services source from specific accounts or Regions.
deleteAwsLogSource_inputOrder :: Lens' DeleteAwsLogSource [Dimension] Source #
This is a mandatory input. Specify the input order to disable dimensions in Security Lake, namely Region (Amazon Web Services Region code, source type, and member (account ID of a specific Amazon Web Services account).
deleteAwsLogSourceResponse_failed :: Lens' DeleteAwsLogSourceResponse (Maybe [Text]) Source #
Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
deleteAwsLogSourceResponse_processing :: Lens' DeleteAwsLogSourceResponse (Maybe [Text]) Source #
Deletion of the Amazon Web Services sources is in progress.
deleteAwsLogSourceResponse_httpStatus :: Lens' DeleteAwsLogSourceResponse Int Source #
The response's http status code.
DeleteCustomLogSource
deleteCustomLogSource_customSourceName :: Lens' DeleteCustomLogSource Text Source #
The custom source name for the custom log source.
deleteCustomLogSourceResponse_httpStatus :: Lens' DeleteCustomLogSourceResponse Int Source #
The response's http status code.
deleteCustomLogSourceResponse_customDataLocation :: Lens' DeleteCustomLogSourceResponse Text Source #
The location of the partition in the Amazon S3 bucket for Security Lake.
DeleteDatalake
deleteDatalakeResponse_httpStatus :: Lens' DeleteDatalakeResponse Int Source #
The response's http status code.
DeleteDatalakeAutoEnable
deleteDatalakeAutoEnable_removeFromConfigurationForNewAccounts :: Lens' DeleteDatalakeAutoEnable [AutoEnableNewRegionConfiguration] Source #
Delete Amazon Security Lake with the specified configuration settings to stop ingesting security data for new accounts in Security Lake.
deleteDatalakeAutoEnableResponse_httpStatus :: Lens' DeleteDatalakeAutoEnableResponse Int Source #
The response's http status code.
DeleteDatalakeDelegatedAdmin
deleteDatalakeDelegatedAdmin_account :: Lens' DeleteDatalakeDelegatedAdmin Text Source #
The account ID the Security Lake delegated administrator.
deleteDatalakeDelegatedAdminResponse_httpStatus :: Lens' DeleteDatalakeDelegatedAdminResponse Int Source #
The response's http status code.
DeleteDatalakeExceptionsSubscription
deleteDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' DeleteDatalakeExceptionsSubscriptionResponse Int Source #
The response's http status code.
deleteDatalakeExceptionsSubscriptionResponse_status :: Lens' DeleteDatalakeExceptionsSubscriptionResponse Text Source #
Retrieves the status of the delete Security Lake operation for an account.
DeleteSubscriber
deleteSubscriber_id :: Lens' DeleteSubscriber Text Source #
A value created by Security Lake that uniquely identifies your
DeleteSubscriber
API request.
deleteSubscriberResponse_httpStatus :: Lens' DeleteSubscriberResponse Int Source #
The response's http status code.
DeleteSubscriptionNotificationConfiguration
deleteSubscriptionNotificationConfiguration_subscriptionId :: Lens' DeleteSubscriptionNotificationConfiguration Text Source #
The ID of the Security Lake subscriber account.
deleteSubscriptionNotificationConfigurationResponse_httpStatus :: Lens' DeleteSubscriptionNotificationConfigurationResponse Int Source #
The response's http status code.
GetDatalake
getDatalakeResponse_httpStatus :: Lens' GetDatalakeResponse Int Source #
The response's http status code.
getDatalakeResponse_configurations :: Lens' GetDatalakeResponse (HashMap Region LakeConfigurationResponse) Source #
Retrieves the Security Lake configuration object.
GetDatalakeAutoEnable
getDatalakeAutoEnableResponse_httpStatus :: Lens' GetDatalakeAutoEnableResponse Int Source #
The response's http status code.
getDatalakeAutoEnableResponse_autoEnableNewAccounts :: Lens' GetDatalakeAutoEnableResponse [AutoEnableNewRegionConfiguration] Source #
The configuration for new accounts.
GetDatalakeExceptionsExpiry
getDatalakeExceptionsExpiryResponse_httpStatus :: Lens' GetDatalakeExceptionsExpiryResponse Int Source #
The response's http status code.
getDatalakeExceptionsExpiryResponse_exceptionMessageExpiry :: Lens' GetDatalakeExceptionsExpiryResponse Integer Source #
The expiration period and time-to-live (TTL).
GetDatalakeExceptionsSubscription
getDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' GetDatalakeExceptionsSubscriptionResponse Int Source #
The response's http status code.
getDatalakeExceptionsSubscriptionResponse_protocolAndNotificationEndpoint :: Lens' GetDatalakeExceptionsSubscriptionResponse ProtocolAndNotificationEndpoint Source #
Retrieves the exception notification subscription information.
GetDatalakeStatus
getDatalakeStatus_accountSet :: Lens' GetDatalakeStatus (Maybe [Text]) Source #
The Amazon Web Services account ID for which a static snapshot of the current Amazon Web Services Region, including enabled accounts and log sources, is retrieved.
getDatalakeStatus_maxAccountResults :: Lens' GetDatalakeStatus (Maybe Int) Source #
The maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
getDatalakeStatus_nextToken :: Lens' GetDatalakeStatus (Maybe Text) Source #
Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
getDatalakeStatusResponse_nextToken :: Lens' GetDatalakeStatusResponse (Maybe Text) Source #
Lists if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
getDatalakeStatusResponse_httpStatus :: Lens' GetDatalakeStatusResponse Int Source #
The response's http status code.
getDatalakeStatusResponse_accountSourcesList :: Lens' GetDatalakeStatusResponse [AccountSources] Source #
The list of enabled accounts and enabled sources.
GetSubscriber
getSubscriber_id :: Lens' GetSubscriber Text Source #
A value created by Amazon Security Lake that uniquely identifies your
GetSubscriber
API request.
getSubscriberResponse_subscriber :: Lens' GetSubscriberResponse (Maybe SubscriberResource) Source #
The subscription information for the specified subscription ID.
getSubscriberResponse_httpStatus :: Lens' GetSubscriberResponse Int Source #
The response's http status code.
ListDatalakeExceptions
listDatalakeExceptions_maxFailures :: Lens' ListDatalakeExceptions (Maybe Int) Source #
List the maximum number of failures in Security Lake.
listDatalakeExceptions_nextToken :: Lens' ListDatalakeExceptions (Maybe Text) Source #
List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
listDatalakeExceptions_regionSet :: Lens' ListDatalakeExceptions (Maybe [Region]) Source #
List the Amazon Web Services Regions from which exceptions are retrieved.
listDatalakeExceptionsResponse_nextToken :: Lens' ListDatalakeExceptionsResponse (Maybe Text) Source #
List if there are more results available. The value of nextToken is a unique pagination token for each page. Repeat the call using the returned token to retrieve the next page. Keep all other arguments unchanged.
Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
listDatalakeExceptionsResponse_httpStatus :: Lens' ListDatalakeExceptionsResponse Int Source #
The response's http status code.
listDatalakeExceptionsResponse_nonRetryableFailures :: Lens' ListDatalakeExceptionsResponse [FailuresResponse] Source #
Lists the failures that cannot be retried in the current Region.
ListLogSources
listLogSources_inputOrder :: Lens' ListLogSources (Maybe [Dimension]) Source #
Lists the log sources in input order, namely Region, source type, and member account.
listLogSources_listAllDimensions :: Lens' ListLogSources (Maybe (HashMap Text (HashMap Text [Text]))) Source #
List the view of log sources for enabled Amazon Security Lake accounts for specific Amazon Web Services sources from specific accounts and specific Regions.
listLogSources_listSingleDimension :: Lens' ListLogSources (Maybe [Text]) Source #
List the view of log sources for enabled Security Lake accounts for all Amazon Web Services sources from specific accounts or specific Regions.
listLogSources_listTwoDimensions :: Lens' ListLogSources (Maybe (HashMap Text [Text])) Source #
Lists the view of log sources for enabled Security Lake accounts for specific Amazon Web Services sources from specific accounts or specific Regions.
listLogSources_maxResults :: Lens' ListLogSources (Maybe Int) Source #
The maximum number of accounts for which the log sources are displayed.
listLogSources_nextToken :: Lens' ListLogSources (Maybe Text) Source #
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
listLogSourcesResponse_nextToken :: Lens' ListLogSourcesResponse (Maybe Text) Source #
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
listLogSourcesResponse_httpStatus :: Lens' ListLogSourcesResponse Int Source #
The response's http status code.
listLogSourcesResponse_regionSourceTypesAccountsList :: Lens' ListLogSourcesResponse [HashMap Text (HashMap Text [Text])] Source #
Lists the log sources by Regions for enabled Security Lake accounts.
ListSubscribers
listSubscribers_maxResults :: Lens' ListSubscribers (Maybe Int) Source #
The maximum number of accounts for which the configuration is displayed.
listSubscribers_nextToken :: Lens' ListSubscribers (Maybe Text) Source #
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
listSubscribersResponse_nextToken :: Lens' ListSubscribersResponse (Maybe Text) Source #
If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
listSubscribersResponse_httpStatus :: Lens' ListSubscribersResponse Int Source #
The response's http status code.
listSubscribersResponse_subscribers :: Lens' ListSubscribersResponse [SubscriberResource] Source #
The subscribers available for the specified Security Lake account ID.
UpdateDatalake
updateDatalake_configurations :: Lens' UpdateDatalake (HashMap Region LakeConfigurationRequest) Source #
Specify the Region or Regions that will contribute data to the rollup region.
updateDatalakeResponse_httpStatus :: Lens' UpdateDatalakeResponse Int Source #
The response's http status code.
UpdateDatalakeExceptionsExpiry
updateDatalakeExceptionsExpiry_exceptionMessageExpiry :: Lens' UpdateDatalakeExceptionsExpiry Natural Source #
The time-to-live (TTL) for the exception message to remain.
updateDatalakeExceptionsExpiryResponse_httpStatus :: Lens' UpdateDatalakeExceptionsExpiryResponse Int Source #
The response's http status code.
UpdateDatalakeExceptionsSubscription
updateDatalakeExceptionsSubscription_notificationEndpoint :: Lens' UpdateDatalakeExceptionsSubscription Text Source #
The account that is subscribed to receive exception notifications.
updateDatalakeExceptionsSubscription_subscriptionProtocol :: Lens' UpdateDatalakeExceptionsSubscription SubscriptionProtocolType Source #
The subscription protocol to which exception messages are posted.
updateDatalakeExceptionsSubscriptionResponse_httpStatus :: Lens' UpdateDatalakeExceptionsSubscriptionResponse Int Source #
The response's http status code.
UpdateSubscriber
updateSubscriber_externalId :: Lens' UpdateSubscriber (Maybe Text) Source #
The external ID of the Security Lake account.
updateSubscriber_subscriberDescription :: Lens' UpdateSubscriber (Maybe Text) Source #
The description of the Security Lake account subscriber.
updateSubscriber_subscriberName :: Lens' UpdateSubscriber (Maybe Text) Source #
The name of the Security Lake account subscriber.
updateSubscriber_id :: Lens' UpdateSubscriber Text Source #
A value created by Security Lake that uniquely identifies your subscription.
updateSubscriber_sourceTypes :: Lens' UpdateSubscriber [SourceType] Source #
The supported Amazon Web Services from which logs and events are collected. For the list of supported Amazon Web Services, see the Amazon Security Lake User Guide.
updateSubscriberResponse_subscriber :: Lens' UpdateSubscriberResponse (Maybe SubscriberResource) Source #
The account of the subscriber.
updateSubscriberResponse_httpStatus :: Lens' UpdateSubscriberResponse Int Source #
The response's http status code.
UpdateSubscriptionNotificationConfiguration
updateSubscriptionNotificationConfiguration_createSqs :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Bool) Source #
Create a new subscription notification for the specified subscription ID in Amazon Security Lake.
updateSubscriptionNotificationConfiguration_httpsApiKeyName :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text) Source #
The key name for the subscription notification.
updateSubscriptionNotificationConfiguration_httpsApiKeyValue :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text) Source #
The key value for the subscription notification.
updateSubscriptionNotificationConfiguration_httpsMethod :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe HttpsMethod) Source #
The HTTPS method used for the subscription notification.
updateSubscriptionNotificationConfiguration_roleArn :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) specifying the role of the subscriber.
updateSubscriptionNotificationConfiguration_subscriptionEndpoint :: Lens' UpdateSubscriptionNotificationConfiguration (Maybe Text) Source #
The subscription endpoint in Security Lake.
updateSubscriptionNotificationConfiguration_subscriptionId :: Lens' UpdateSubscriptionNotificationConfiguration Text Source #
The subscription ID for which the subscription notification is specified.
updateSubscriptionNotificationConfigurationResponse_queueArn :: Lens' UpdateSubscriptionNotificationConfigurationResponse (Maybe Text) Source #
Returns the ARN of the queue.
updateSubscriptionNotificationConfigurationResponse_httpStatus :: Lens' UpdateSubscriptionNotificationConfigurationResponse Int Source #
The response's http status code.
Types
AccountSources
accountSources_eventClass :: Lens' AccountSources (Maybe OcsfEventClass) Source #
Initializes a new instance of the Event class.
accountSources_logsStatus :: Lens' AccountSources (Maybe [LogsStatus]) Source #
The log status for the Security Lake account.
accountSources_account :: Lens' AccountSources Text Source #
The ID of the Security Lake account for which logs are collected.
accountSources_sourceType :: Lens' AccountSources Text Source #
The supported Amazon Web Services from which logs and events are collected. Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
AutoEnableNewRegionConfiguration
autoEnableNewRegionConfiguration_region :: Lens' AutoEnableNewRegionConfiguration Region Source #
The Amazon Web Services Regions where Security Lake is automatically enabled.
autoEnableNewRegionConfiguration_sources :: Lens' AutoEnableNewRegionConfiguration [AwsLogSourceType] Source #
The Amazon Web Services sources that are automatically enabled in Security Lake.
Failures
failures_timestamp :: Lens' Failures UTCTime Source #
This error can occur if you configure the wrong timestamp format, or if the subset of entries used for validation had errors or missing values.
FailuresResponse
failuresResponse_failures :: Lens' FailuresResponse (Maybe [Failures]) Source #
List of all failures.
failuresResponse_region :: Lens' FailuresResponse (Maybe Text) Source #
List of Amazon Web Services Regions where the failure occurred.
LakeConfigurationRequest
lakeConfigurationRequest_encryptionKey :: Lens' LakeConfigurationRequest (Maybe Text) Source #
The type of encryption key used by Amazon Security Lake to encrypt the Security Lake configuration object.
lakeConfigurationRequest_replicationDestinationRegions :: Lens' LakeConfigurationRequest (Maybe [Region]) Source #
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.
lakeConfigurationRequest_replicationRoleArn :: Lens' LakeConfigurationRequest (Maybe Text) Source #
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.
lakeConfigurationRequest_retentionSettings :: Lens' LakeConfigurationRequest (Maybe [RetentionSetting]) Source #
Retention settings for the destination Amazon S3 buckets.
lakeConfigurationRequest_tagsMap :: Lens' LakeConfigurationRequest (Maybe (HashMap Text Text)) Source #
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
LakeConfigurationResponse
lakeConfigurationResponse_encryptionKey :: Lens' LakeConfigurationResponse (Maybe Text) Source #
The type of encryption key used by secure the Security Lake configuration object.
lakeConfigurationResponse_replicationDestinationRegions :: Lens' LakeConfigurationResponse (Maybe [Region]) Source #
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.
lakeConfigurationResponse_replicationRoleArn :: Lens' LakeConfigurationResponse (Maybe Text) Source #
Replication settings for the Amazon S3 buckets. This parameter uses the IAM role you created that is managed by Security Lake, to ensure the replication setting is correct.
lakeConfigurationResponse_retentionSettings :: Lens' LakeConfigurationResponse (Maybe [RetentionSetting]) Source #
Retention settings for the destination Amazon S3 buckets.
lakeConfigurationResponse_s3BucketArn :: Lens' LakeConfigurationResponse (Maybe Text) Source #
Amazon Resource Names (ARNs) uniquely identify Amazon Web Services resources. Security Lake requires an ARN when you need to specify a resource unambiguously across all of Amazon Web Services, such as in IAM policies, Amazon Relational Database Service (Amazon RDS) tags, and API calls.
lakeConfigurationResponse_status :: Lens' LakeConfigurationResponse (Maybe SettingsStatus) Source #
Retrieves the status of the configuration operation for an account in Amazon Security Lake.
lakeConfigurationResponse_tagsMap :: Lens' LakeConfigurationResponse (Maybe (HashMap Text Text)) Source #
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define.
LogsStatus
logsStatus_healthStatus :: Lens' LogsStatus SourceStatus Source #
The health status of services, including error codes and patterns.
logsStatus_pathToLogs :: Lens' LogsStatus Text Source #
Defines path the stored logs are available which has information on your systems, applications, and services.
ProtocolAndNotificationEndpoint
protocolAndNotificationEndpoint_endpoint :: Lens' ProtocolAndNotificationEndpoint (Maybe Text) Source #
The account that is subscribed to receive exception notifications.
protocolAndNotificationEndpoint_protocol :: Lens' ProtocolAndNotificationEndpoint (Maybe Text) Source #
The protocol to which notification messages are posted.
RetentionSetting
retentionSetting_retentionPeriod :: Lens' RetentionSetting (Maybe Natural) Source #
The retention period specifies a fixed period of time during which the Security Lake object remains locked. You can specify the retention period in days for one or more sources.
retentionSetting_storageClass :: Lens' RetentionSetting (Maybe StorageClass) Source #
The range of storage classes that you can choose from based on the data access, resiliency, and cost requirements of your workloads.
SourceType
sourceType_awsSourceType :: Lens' SourceType (Maybe AwsLogSourceType) Source #
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services.
sourceType_customSourceType :: Lens' SourceType (Maybe Text) Source #
Amazon Security Lake supports custom source types. For a detailed list, see the Amazon Security Lake User Guide.
SubscriberResource
subscriberResource_accessTypes :: Lens' SubscriberResource (Maybe [AccessType]) Source #
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
.
subscriberResource_createdAt :: Lens' SubscriberResource (Maybe UTCTime) Source #
The date and time when the subscription was created.
subscriberResource_externalId :: Lens' SubscriberResource (Maybe Text) Source #
The external ID of the subscriber. The external ID lets the user that is assuming the role assert the circumstances in which they are operating. It also provides a way for the account owner to permit the role to be assumed only under specific circumstances.
subscriberResource_roleArn :: Lens' SubscriberResource (Maybe Text) Source #
The Amazon Resource Name (ARN) specifying the role of the subscriber.
subscriberResource_s3BucketArn :: Lens' SubscriberResource (Maybe Text) Source #
The ARN for the Amazon S3 bucket.
subscriberResource_snsArn :: Lens' SubscriberResource (Maybe Text) Source #
The ARN for the Amazon Simple Notification Service.
subscriberResource_subscriberDescription :: Lens' SubscriberResource (Maybe Text) Source #
The subscriber descriptions for a subscriber account. The description
for a subscriber includes subscriberName
, accountID
, externalID
,
and subscriptionId
.
subscriberResource_subscriberName :: Lens' SubscriberResource (Maybe Text) Source #
The name of your Amazon Security Lake subscriber account.
subscriberResource_subscriptionEndpoint :: Lens' SubscriberResource (Maybe Text) Source #
The subscription endpoint to which exception messages are posted.
subscriberResource_subscriptionProtocol :: Lens' SubscriberResource (Maybe EndpointProtocol) Source #
The subscription protocol to which exception messages are posted.
subscriberResource_subscriptionStatus :: Lens' SubscriberResource (Maybe SubscriptionStatus) Source #
The subscription status of the Amazon Security Lake subscriber account.
subscriberResource_updatedAt :: Lens' SubscriberResource (Maybe UTCTime) Source #
The date and time when the subscription was created.
subscriberResource_accountId :: Lens' SubscriberResource Text Source #
The Amazon Web Services account ID you are using to create your Amazon Security Lake account.
subscriberResource_sourceTypes :: Lens' SubscriberResource [SourceType] Source #
Amazon Security Lake supports log and event collection for natively supported Amazon Web Services. For more information, see the Amazon Security Lake User Guide.
subscriberResource_subscriptionId :: Lens' SubscriberResource Text Source #
The subscription ID of the Amazon Security Lake subscriber account.