pub struct Client { /* private fields */ }
Expand description
Client for Amazon Security Lake
Client for invoking operations on Amazon Security Lake. Each operation on Amazon Security Lake is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_securitylake::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_securitylake::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateCustomLogSource
operation has
a Client::create_custom_log_source
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_custom_log_source()
.source_name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn create_aws_log_source(&self) -> CreateAwsLogSourceFluentBuilder
pub fn create_aws_log_source(&self) -> CreateAwsLogSourceFluentBuilder
Constructs a fluent builder for the CreateAwsLogSource
operation.
- The fluent builder is configurable:
sources(AwsLogSourceConfiguration)
/set_sources(Option<Vec::<AwsLogSourceConfiguration>>)
:
required: trueSpecify the natively-supported Amazon Web Services service to add as a source in Security Lake.
- On success, responds with
CreateAwsLogSourceOutput
with field(s):failed(Option<Vec::<String>>)
:Lists all accounts in which enabling a natively supported Amazon Web Services service as a Security Lake source failed. The failure occurred as these accounts are not part of an organization.
- On failure, responds with
SdkError<CreateAwsLogSourceError>
Source§impl Client
impl Client
Sourcepub fn create_custom_log_source(&self) -> CreateCustomLogSourceFluentBuilder
pub fn create_custom_log_source(&self) -> CreateCustomLogSourceFluentBuilder
Constructs a fluent builder for the CreateCustomLogSource
operation.
- The fluent builder is configurable:
source_name(impl Into<String>)
/set_source_name(Option<String>)
:
required: trueSpecify the name for a third-party custom source. This must be a Regionally unique value. The
sourceName
you enter here, is used in theLogProviderRole
name which follows the conventionAmazonSecurityLake-Provider-{name of the custom source}-{region}
. You must use aCustomLogSource
name that is shorter than or equal to 20 characters. This ensures that theLogProviderRole
name is below the 64 character limit.source_version(impl Into<String>)
/set_source_version(Option<String>)
:
required: falseSpecify the source version for the third-party custom source, to limit log collection to a specific version of custom data source.
event_classes(impl Into<String>)
/set_event_classes(Option<Vec::<String>>)
:
required: falseThe Open Cybersecurity Schema Framework (OCSF) event classes which describes the type of data that the custom source will send to Security Lake. For the list of supported event classes, see the Amazon Security Lake User Guide.
configuration(CustomLogSourceConfiguration)
/set_configuration(Option<CustomLogSourceConfiguration>)
:
required: trueThe configuration used for the third-party custom source.
- On success, responds with
CreateCustomLogSourceOutput
with field(s):source(Option<CustomLogSourceResource>)
:The third-party custom source that was created.
- On failure, responds with
SdkError<CreateCustomLogSourceError>
Source§impl Client
impl Client
Sourcepub fn create_data_lake(&self) -> CreateDataLakeFluentBuilder
pub fn create_data_lake(&self) -> CreateDataLakeFluentBuilder
Constructs a fluent builder for the CreateDataLake
operation.
- The fluent builder is configurable:
configurations(DataLakeConfiguration)
/set_configurations(Option<Vec::<DataLakeConfiguration>>)
:
required: trueSpecify the Region or Regions that will contribute data to the rollup region.
meta_store_manager_role_arn(impl Into<String>)
/set_meta_store_manager_role_arn(Option<String>)
:
required: trueThe 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.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn array of objects, one for each tag to associate with the data lake configuration. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
- On success, responds with
CreateDataLakeOutput
with field(s):data_lakes(Option<Vec::<DataLakeResource>>)
:The created Security Lake configuration object.
- On failure, responds with
SdkError<CreateDataLakeError>
Source§impl Client
impl Client
Sourcepub fn create_data_lake_exception_subscription(
&self,
) -> CreateDataLakeExceptionSubscriptionFluentBuilder
pub fn create_data_lake_exception_subscription( &self, ) -> CreateDataLakeExceptionSubscriptionFluentBuilder
Constructs a fluent builder for the CreateDataLakeExceptionSubscription
operation.
- The fluent builder is configurable:
subscription_protocol(impl Into<String>)
/set_subscription_protocol(Option<String>)
:
required: trueThe subscription protocol to which exception notifications are posted.
notification_endpoint(impl Into<String>)
/set_notification_endpoint(Option<String>)
:
required: trueThe Amazon Web Services account where you want to receive exception notifications.
exception_time_to_live(i64)
/set_exception_time_to_live(Option<i64>)
:
required: falseThe expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.
- On success, responds with
CreateDataLakeExceptionSubscriptionOutput
- On failure, responds with
SdkError<CreateDataLakeExceptionSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn create_data_lake_organization_configuration(
&self,
) -> CreateDataLakeOrganizationConfigurationFluentBuilder
pub fn create_data_lake_organization_configuration( &self, ) -> CreateDataLakeOrganizationConfigurationFluentBuilder
Constructs a fluent builder for the CreateDataLakeOrganizationConfiguration
operation.
- The fluent builder is configurable:
auto_enable_new_account(DataLakeAutoEnableNewAccountConfiguration)
/set_auto_enable_new_account(Option<Vec::<DataLakeAutoEnableNewAccountConfiguration>>)
:
required: falseEnable Security Lake with the specified configuration settings, to begin collecting security data for new accounts in your organization.
- On success, responds with
CreateDataLakeOrganizationConfigurationOutput
- On failure, responds with
SdkError<CreateDataLakeOrganizationConfigurationError>
Source§impl Client
impl Client
Sourcepub fn create_subscriber(&self) -> CreateSubscriberFluentBuilder
pub fn create_subscriber(&self) -> CreateSubscriberFluentBuilder
Constructs a fluent builder for the CreateSubscriber
operation.
- The fluent builder is configurable:
subscriber_identity(AwsIdentity)
/set_subscriber_identity(Option<AwsIdentity>)
:
required: trueThe Amazon Web Services identity used to access your data.
subscriber_name(impl Into<String>)
/set_subscriber_name(Option<String>)
:
required: trueThe name of your Security Lake subscriber account.
subscriber_description(impl Into<String>)
/set_subscriber_description(Option<String>)
:
required: falseThe description for your subscriber account in Security Lake.
sources(LogSourceResource)
/set_sources(Option<Vec::<LogSourceResource>>)
:
required: trueThe supported Amazon Web Services services from which logs and events are collected. Security Lake supports log and event collection for natively supported Amazon Web Services services.
access_types(AccessType)
/set_access_types(Option<Vec::<AccessType>>)
:
required: falseThe Amazon S3 or Lake Formation access type.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn array of objects, one for each tag to associate with the subscriber. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
- On success, responds with
CreateSubscriberOutput
with field(s):subscriber(Option<SubscriberResource>)
:Retrieve information about the subscriber created using the
CreateSubscriber
API.
- On failure, responds with
SdkError<CreateSubscriberError>
Source§impl Client
impl Client
Sourcepub fn create_subscriber_notification(
&self,
) -> CreateSubscriberNotificationFluentBuilder
pub fn create_subscriber_notification( &self, ) -> CreateSubscriberNotificationFluentBuilder
Constructs a fluent builder for the CreateSubscriberNotification
operation.
- The fluent builder is configurable:
subscriber_id(impl Into<String>)
/set_subscriber_id(Option<String>)
:
required: trueThe subscriber ID for the notification subscription.
configuration(NotificationConfiguration)
/set_configuration(Option<NotificationConfiguration>)
:
required: trueSpecify the configuration using which you want to create the subscriber notification.
- On success, responds with
CreateSubscriberNotificationOutput
with field(s):subscriber_endpoint(Option<String>)
:The subscriber endpoint to which exception messages are posted.
- On failure, responds with
SdkError<CreateSubscriberNotificationError>
Source§impl Client
impl Client
Sourcepub fn delete_aws_log_source(&self) -> DeleteAwsLogSourceFluentBuilder
pub fn delete_aws_log_source(&self) -> DeleteAwsLogSourceFluentBuilder
Constructs a fluent builder for the DeleteAwsLogSource
operation.
- The fluent builder is configurable:
sources(AwsLogSourceConfiguration)
/set_sources(Option<Vec::<AwsLogSourceConfiguration>>)
:
required: trueSpecify the natively-supported Amazon Web Services service to remove as a source in Security Lake.
- On success, responds with
DeleteAwsLogSourceOutput
with field(s):failed(Option<Vec::<String>>)
:Deletion of the Amazon Web Services sources failed as the account is not a part of the organization.
- On failure, responds with
SdkError<DeleteAwsLogSourceError>
Source§impl Client
impl Client
Sourcepub fn delete_custom_log_source(&self) -> DeleteCustomLogSourceFluentBuilder
pub fn delete_custom_log_source(&self) -> DeleteCustomLogSourceFluentBuilder
Constructs a fluent builder for the DeleteCustomLogSource
operation.
- The fluent builder is configurable:
source_name(impl Into<String>)
/set_source_name(Option<String>)
:
required: trueThe source name of custom log source that you want to delete.
source_version(impl Into<String>)
/set_source_version(Option<String>)
:
required: falseThe source version for the third-party custom source. You can limit the custom source removal to the specified source version.
- On success, responds with
DeleteCustomLogSourceOutput
- On failure, responds with
SdkError<DeleteCustomLogSourceError>
Source§impl Client
impl Client
Sourcepub fn delete_data_lake(&self) -> DeleteDataLakeFluentBuilder
pub fn delete_data_lake(&self) -> DeleteDataLakeFluentBuilder
Constructs a fluent builder for the DeleteDataLake
operation.
- The fluent builder is configurable:
regions(impl Into<String>)
/set_regions(Option<Vec::<String>>)
:
required: trueThe list of Regions where Security Lake is enabled.
- On success, responds with
DeleteDataLakeOutput
- On failure, responds with
SdkError<DeleteDataLakeError>
Source§impl Client
impl Client
Sourcepub fn delete_data_lake_exception_subscription(
&self,
) -> DeleteDataLakeExceptionSubscriptionFluentBuilder
pub fn delete_data_lake_exception_subscription( &self, ) -> DeleteDataLakeExceptionSubscriptionFluentBuilder
Constructs a fluent builder for the DeleteDataLakeExceptionSubscription
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DeleteDataLakeExceptionSubscriptionOutput
- On failure, responds with
SdkError<DeleteDataLakeExceptionSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn delete_data_lake_organization_configuration(
&self,
) -> DeleteDataLakeOrganizationConfigurationFluentBuilder
pub fn delete_data_lake_organization_configuration( &self, ) -> DeleteDataLakeOrganizationConfigurationFluentBuilder
Constructs a fluent builder for the DeleteDataLakeOrganizationConfiguration
operation.
- The fluent builder is configurable:
auto_enable_new_account(DataLakeAutoEnableNewAccountConfiguration)
/set_auto_enable_new_account(Option<Vec::<DataLakeAutoEnableNewAccountConfiguration>>)
:
required: falseTurns off automatic enablement of Security Lake for member accounts that are added to an organization.
- On success, responds with
DeleteDataLakeOrganizationConfigurationOutput
- On failure, responds with
SdkError<DeleteDataLakeOrganizationConfigurationError>
Source§impl Client
impl Client
Sourcepub fn delete_subscriber(&self) -> DeleteSubscriberFluentBuilder
pub fn delete_subscriber(&self) -> DeleteSubscriberFluentBuilder
Constructs a fluent builder for the DeleteSubscriber
operation.
- The fluent builder is configurable:
subscriber_id(impl Into<String>)
/set_subscriber_id(Option<String>)
:
required: trueA value created by Security Lake that uniquely identifies your
DeleteSubscriber
API request.
- On success, responds with
DeleteSubscriberOutput
- On failure, responds with
SdkError<DeleteSubscriberError>
Source§impl Client
impl Client
Sourcepub fn delete_subscriber_notification(
&self,
) -> DeleteSubscriberNotificationFluentBuilder
pub fn delete_subscriber_notification( &self, ) -> DeleteSubscriberNotificationFluentBuilder
Constructs a fluent builder for the DeleteSubscriberNotification
operation.
- The fluent builder is configurable:
subscriber_id(impl Into<String>)
/set_subscriber_id(Option<String>)
:
required: trueThe ID of the Security Lake subscriber account.
- On success, responds with
DeleteSubscriberNotificationOutput
- On failure, responds with
SdkError<DeleteSubscriberNotificationError>
Source§impl Client
impl Client
Sourcepub fn deregister_data_lake_delegated_administrator(
&self,
) -> DeregisterDataLakeDelegatedAdministratorFluentBuilder
pub fn deregister_data_lake_delegated_administrator( &self, ) -> DeregisterDataLakeDelegatedAdministratorFluentBuilder
Constructs a fluent builder for the DeregisterDataLakeDelegatedAdministrator
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
DeregisterDataLakeDelegatedAdministratorOutput
- On failure, responds with
SdkError<DeregisterDataLakeDelegatedAdministratorError>
Source§impl Client
impl Client
Sourcepub fn get_data_lake_exception_subscription(
&self,
) -> GetDataLakeExceptionSubscriptionFluentBuilder
pub fn get_data_lake_exception_subscription( &self, ) -> GetDataLakeExceptionSubscriptionFluentBuilder
Constructs a fluent builder for the GetDataLakeExceptionSubscription
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetDataLakeExceptionSubscriptionOutput
with field(s):subscription_protocol(Option<String>)
:The subscription protocol to which exception notifications are posted.
notification_endpoint(Option<String>)
:The Amazon Web Services account where you receive exception notifications.
exception_time_to_live(Option<i64>)
:The expiration period and time-to-live (TTL). It is the duration of time until which the exception message remains.
- On failure, responds with
SdkError<GetDataLakeExceptionSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn get_data_lake_organization_configuration(
&self,
) -> GetDataLakeOrganizationConfigurationFluentBuilder
pub fn get_data_lake_organization_configuration( &self, ) -> GetDataLakeOrganizationConfigurationFluentBuilder
Constructs a fluent builder for the GetDataLakeOrganizationConfiguration
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
GetDataLakeOrganizationConfigurationOutput
with field(s):auto_enable_new_account(Option<Vec::<DataLakeAutoEnableNewAccountConfiguration>>)
:The configuration used for new accounts in Security Lake.
- On failure, responds with
SdkError<GetDataLakeOrganizationConfigurationError>
Source§impl Client
impl Client
Sourcepub fn get_data_lake_sources(&self) -> GetDataLakeSourcesFluentBuilder
pub fn get_data_lake_sources(&self) -> GetDataLakeSourcesFluentBuilder
Constructs a fluent builder for the GetDataLakeSources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
accounts(impl Into<String>)
/set_accounts(Option<Vec::<String>>)
:
required: falseThe 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.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum limit of accounts for which the static snapshot of the current Region, including enabled accounts and log sources, is retrieved.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseLists 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.
- On success, responds with
GetDataLakeSourcesOutput
with field(s):data_lake_arn(Option<String>)
:The Amazon Resource Name (ARN) created by you to provide to the subscriber. For more information about ARNs and how to use them in policies, see the Amazon Security Lake User Guide.
data_lake_sources(Option<Vec::<DataLakeSource>>)
:The list of enabled accounts and enabled sources.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<GetDataLakeSourcesError>
Source§impl Client
impl Client
Sourcepub fn get_subscriber(&self) -> GetSubscriberFluentBuilder
pub fn get_subscriber(&self) -> GetSubscriberFluentBuilder
Constructs a fluent builder for the GetSubscriber
operation.
- The fluent builder is configurable:
subscriber_id(impl Into<String>)
/set_subscriber_id(Option<String>)
:
required: trueA value created by Amazon Security Lake that uniquely identifies your
GetSubscriber
API request.
- On success, responds with
GetSubscriberOutput
with field(s):subscriber(Option<SubscriberResource>)
:The subscriber information for the specified subscriber ID.
- On failure, responds with
SdkError<GetSubscriberError>
Source§impl Client
impl Client
Sourcepub fn list_data_lake_exceptions(&self) -> ListDataLakeExceptionsFluentBuilder
pub fn list_data_lake_exceptions(&self) -> ListDataLakeExceptionsFluentBuilder
Constructs a fluent builder for the ListDataLakeExceptions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
regions(impl Into<String>)
/set_regions(Option<Vec::<String>>)
:
required: falseThe Amazon Web Services Regions from which exceptions are retrieved.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseLists the maximum number of failures in Security Lake.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseLists 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.
- On success, responds with
ListDataLakeExceptionsOutput
with field(s):exceptions(Option<Vec::<DataLakeException>>)
:Lists the failures that cannot be retried.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListDataLakeExceptionsError>
Source§impl Client
impl Client
Sourcepub fn list_data_lakes(&self) -> ListDataLakesFluentBuilder
pub fn list_data_lakes(&self) -> ListDataLakesFluentBuilder
Constructs a fluent builder for the ListDataLakes
operation.
- The fluent builder is configurable:
regions(impl Into<String>)
/set_regions(Option<Vec::<String>>)
:
required: falseThe list of Regions where Security Lake is enabled.
- On success, responds with
ListDataLakesOutput
with field(s):data_lakes(Option<Vec::<DataLakeResource>>)
:Retrieves the Security Lake configuration object.
- On failure, responds with
SdkError<ListDataLakesError>
Source§impl Client
impl Client
Sourcepub fn list_log_sources(&self) -> ListLogSourcesFluentBuilder
pub fn list_log_sources(&self) -> ListLogSourcesFluentBuilder
Constructs a fluent builder for the ListLogSources
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
accounts(impl Into<String>)
/set_accounts(Option<Vec::<String>>)
:
required: falseThe list of Amazon Web Services accounts for which log sources are displayed.
regions(impl Into<String>)
/set_regions(Option<Vec::<String>>)
:
required: falseThe list of Regions for which log sources are displayed.
sources(LogSourceResource)
/set_sources(Option<Vec::<LogSourceResource>>)
:
required: falseThe list of sources for which log sources are displayed.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of accounts for which the log sources are displayed.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
- On success, responds with
ListLogSourcesOutput
with field(s):sources(Option<Vec::<LogSource>>)
:The list of log sources in your organization that send data to the data lake.
next_token(Option<String>)
:If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
- On failure, responds with
SdkError<ListLogSourcesError>
Source§impl Client
impl Client
Sourcepub fn list_subscribers(&self) -> ListSubscribersFluentBuilder
pub fn list_subscribers(&self) -> ListSubscribersFluentBuilder
Constructs a fluent builder for the ListSubscribers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseIf nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of accounts for which the configuration is displayed.
- On success, responds with
ListSubscribersOutput
with field(s):subscribers(Option<Vec::<SubscriberResource>>)
:The subscribers available for the specified Security Lake account ID.
next_token(Option<String>)
:If nextToken is returned, there are more results available. You can repeat the call using the returned token to retrieve the next page.
- On failure, responds with
SdkError<ListSubscribersError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon Security Lake resource for which you want to retrieve the tags.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<Vec::<Tag>>)
:An array of objects, one for each tag (key and value) that’s associated with the Amazon Security Lake resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn register_data_lake_delegated_administrator(
&self,
) -> RegisterDataLakeDelegatedAdministratorFluentBuilder
pub fn register_data_lake_delegated_administrator( &self, ) -> RegisterDataLakeDelegatedAdministratorFluentBuilder
Constructs a fluent builder for the RegisterDataLakeDelegatedAdministrator
operation.
- The fluent builder is configurable:
account_id(impl Into<String>)
/set_account_id(Option<String>)
:
required: trueThe Amazon Web Services account ID of the Security Lake delegated administrator.
- On success, responds with
RegisterDataLakeDelegatedAdministratorOutput
- On failure, responds with
SdkError<RegisterDataLakeDelegatedAdministratorError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon Security Lake resource to add or update the tags for.
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: trueAn array of objects, one for each tag (key and value) to associate with the Amazon Security Lake resource. For each tag, you must specify both a tag key and a tag value. A tag value cannot be null, but it can be an empty string.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the Amazon Security Lake resource to remove one or more tags from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueA list of one or more tag keys. For each value in the list, specify the tag key for a tag to remove from the Amazon Security Lake resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_data_lake(&self) -> UpdateDataLakeFluentBuilder
pub fn update_data_lake(&self) -> UpdateDataLakeFluentBuilder
Constructs a fluent builder for the UpdateDataLake
operation.
- The fluent builder is configurable:
configurations(DataLakeConfiguration)
/set_configurations(Option<Vec::<DataLakeConfiguration>>)
:
required: trueSpecifies the Region or Regions that will contribute data to the rollup region.
meta_store_manager_role_arn(impl Into<String>)
/set_meta_store_manager_role_arn(Option<String>)
:
required: falseThe 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.
- On success, responds with
UpdateDataLakeOutput
with field(s):data_lakes(Option<Vec::<DataLakeResource>>)
:The created Security Lake configuration object.
- On failure, responds with
SdkError<UpdateDataLakeError>
Source§impl Client
impl Client
Sourcepub fn update_data_lake_exception_subscription(
&self,
) -> UpdateDataLakeExceptionSubscriptionFluentBuilder
pub fn update_data_lake_exception_subscription( &self, ) -> UpdateDataLakeExceptionSubscriptionFluentBuilder
Constructs a fluent builder for the UpdateDataLakeExceptionSubscription
operation.
- The fluent builder is configurable:
subscription_protocol(impl Into<String>)
/set_subscription_protocol(Option<String>)
:
required: trueThe subscription protocol to which exception messages are posted.
notification_endpoint(impl Into<String>)
/set_notification_endpoint(Option<String>)
:
required: trueThe account that is subscribed to receive exception notifications.
exception_time_to_live(i64)
/set_exception_time_to_live(Option<i64>)
:
required: falseThe time-to-live (TTL) for the exception message to remain. It is the duration of time until which the exception message remains.
- On success, responds with
UpdateDataLakeExceptionSubscriptionOutput
- On failure, responds with
SdkError<UpdateDataLakeExceptionSubscriptionError>
Source§impl Client
impl Client
Sourcepub fn update_subscriber(&self) -> UpdateSubscriberFluentBuilder
pub fn update_subscriber(&self) -> UpdateSubscriberFluentBuilder
Constructs a fluent builder for the UpdateSubscriber
operation.
- The fluent builder is configurable:
subscriber_id(impl Into<String>)
/set_subscriber_id(Option<String>)
:
required: trueA value created by Security Lake that uniquely identifies your subscription.
subscriber_identity(AwsIdentity)
/set_subscriber_identity(Option<AwsIdentity>)
:
required: falseThe Amazon Web Services identity used to access your data.
subscriber_name(impl Into<String>)
/set_subscriber_name(Option<String>)
:
required: falseThe name of the Security Lake account subscriber.
subscriber_description(impl Into<String>)
/set_subscriber_description(Option<String>)
:
required: falseThe description of the Security Lake account subscriber.
sources(LogSourceResource)
/set_sources(Option<Vec::<LogSourceResource>>)
:
required: falseThe supported Amazon Web Services services from which logs and events are collected. For the list of supported Amazon Web Services services, see the Amazon Security Lake User Guide.
- On success, responds with
UpdateSubscriberOutput
with field(s):subscriber(Option<SubscriberResource>)
:The updated subscriber information.
- On failure, responds with
SdkError<UpdateSubscriberError>
Source§impl Client
impl Client
Sourcepub fn update_subscriber_notification(
&self,
) -> UpdateSubscriberNotificationFluentBuilder
pub fn update_subscriber_notification( &self, ) -> UpdateSubscriberNotificationFluentBuilder
Constructs a fluent builder for the UpdateSubscriberNotification
operation.
- The fluent builder is configurable:
subscriber_id(impl Into<String>)
/set_subscriber_id(Option<String>)
:
required: trueThe subscription ID for which the subscription notification is specified.
configuration(NotificationConfiguration)
/set_configuration(Option<NotificationConfiguration>)
:
required: trueThe configuration for subscriber notification.
- On success, responds with
UpdateSubscriberNotificationOutput
with field(s):subscriber_endpoint(Option<String>)
:The subscriber endpoint to which exception messages are posted.
- On failure, responds with
SdkError<UpdateSubscriberNotificationError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);