Struct aws_sdk_guardduty::Client
source · pub struct Client { /* private fields */ }Expand description
Client for Amazon GuardDuty
Client for invoking operations on Amazon GuardDuty. Each operation on Amazon GuardDuty 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_guardduty::Client::new(&config);Occasionally, SDKs may have additional service-specific that can be set on the Config that
is absent from SdkConfig, or slightly different settings for a specific client may be desired.
The Config 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_guardduty::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 AcceptAdministratorInvitation operation has
a Client::accept_administrator_invitation, 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.accept_administrator_invitation()
.detector_id("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 accept_administrator_invitation(
&self
) -> AcceptAdministratorInvitationFluentBuilder
pub fn accept_administrator_invitation( &self ) -> AcceptAdministratorInvitationFluentBuilder
Constructs a fluent builder for the AcceptAdministratorInvitation operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
administrator_id(impl Into<String>)/set_administrator_id(Option<String>):
required: trueThe account ID of the GuardDuty administrator account whose invitation you’re accepting.
invitation_id(impl Into<String>)/set_invitation_id(Option<String>):
required: trueThe value that is used to validate the administrator account to the member account.
- On success, responds with
AcceptAdministratorInvitationOutput - On failure, responds with
SdkError<AcceptAdministratorInvitationError>
source§impl Client
impl Client
sourcepub fn accept_invitation(&self) -> AcceptInvitationFluentBuilder
👎Deprecated: This operation is deprecated, use AcceptAdministratorInvitation instead
pub fn accept_invitation(&self) -> AcceptInvitationFluentBuilder
Constructs a fluent builder for the AcceptInvitation operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
master_id(impl Into<String>)/set_master_id(Option<String>):
required: trueThe account ID of the GuardDuty administrator account whose invitation you’re accepting.
invitation_id(impl Into<String>)/set_invitation_id(Option<String>):
required: trueThe value that is used to validate the administrator account to the member account.
- On success, responds with
AcceptInvitationOutput - On failure, responds with
SdkError<AcceptInvitationError>
source§impl Client
impl Client
sourcepub fn archive_findings(&self) -> ArchiveFindingsFluentBuilder
pub fn archive_findings(&self) -> ArchiveFindingsFluentBuilder
Constructs a fluent builder for the ArchiveFindings operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector that specifies the GuardDuty service whose findings you want to archive.
finding_ids(impl Into<String>)/set_finding_ids(Option<Vec::<String>>):
required: trueThe IDs of the findings that you want to archive.
- On success, responds with
ArchiveFindingsOutput - On failure, responds with
SdkError<ArchiveFindingsError>
source§impl Client
impl Client
sourcepub fn create_detector(&self) -> CreateDetectorFluentBuilder
pub fn create_detector(&self) -> CreateDetectorFluentBuilder
Constructs a fluent builder for the CreateDetector operation.
- The fluent builder is configurable:
enable(bool)/set_enable(Option<bool>):
required: trueA Boolean value that specifies whether the detector is to be enabled.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseThe idempotency token for the create request.
finding_publishing_frequency(FindingPublishingFrequency)/set_finding_publishing_frequency(Option<FindingPublishingFrequency>):
required: falseA value that specifies how frequently updated findings are exported.
data_sources(DataSourceConfigurations)/set_data_sources(Option<DataSourceConfigurations>):
required: falseDescribes which data sources will be enabled for the detector.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe tags to be added to a new detector resource.
features(DetectorFeatureConfiguration)/set_features(Option<Vec::<DetectorFeatureConfiguration>>):
required: falseA list of features that will be configured for the detector.
- On success, responds with
CreateDetectorOutputwith field(s):detector_id(Option<String>):The unique ID of the created detector.
unprocessed_data_sources(Option<UnprocessedDataSourcesResult>):Specifies the data sources that couldn’t be enabled when GuardDuty was enabled for the first time.
- On failure, responds with
SdkError<CreateDetectorError>
source§impl Client
impl Client
sourcepub fn create_filter(&self) -> CreateFilterFluentBuilder
pub fn create_filter(&self) -> CreateFilterFluentBuilder
Constructs a fluent builder for the CreateFilter operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector belonging to the GuardDuty account that you want to create a filter for.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe name of the filter. Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses (
{ },[ ], and( )), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.action(FilterAction)/set_action(Option<FilterAction>):
required: falseSpecifies the action that is to be applied to the findings that match the filter.
rank(i32)/set_rank(Option<i32>):
required: falseSpecifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
finding_criteria(FindingCriteria)/set_finding_criteria(Option<FindingCriteria>):
required: trueRepresents the criteria to be used in the filter for querying findings.
You can only use the following attributes to query findings:
-
accountId
-
id
-
region
-
severity
To filter on the basis of severity, the API and CLI use the following input list for the FindingCriteria condition:
-
Low:
[“1”, “2”, “3”] -
Medium:
[“4”, “5”, “6”] -
High:
[“7”, “8”, “9”]
For more information, see Severity levels for GuardDuty findings.
-
-
type
-
updatedAt
Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.
-
resource.accessKeyDetails.accessKeyId
-
resource.accessKeyDetails.principalId
-
resource.accessKeyDetails.userName
-
resource.accessKeyDetails.userType
-
resource.instanceDetails.iamInstanceProfile.id
-
resource.instanceDetails.imageId
-
resource.instanceDetails.instanceId
-
resource.instanceDetails.tags.key
-
resource.instanceDetails.tags.value
-
resource.instanceDetails.networkInterfaces.ipv6Addresses
-
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
-
resource.instanceDetails.networkInterfaces.publicDnsName
-
resource.instanceDetails.networkInterfaces.publicIp
-
resource.instanceDetails.networkInterfaces.securityGroups.groupId
-
resource.instanceDetails.networkInterfaces.securityGroups.groupName
-
resource.instanceDetails.networkInterfaces.subnetId
-
resource.instanceDetails.networkInterfaces.vpcId
-
resource.instanceDetails.outpostArn
-
resource.resourceType
-
resource.s3BucketDetails.publicAccess.effectivePermissions
-
resource.s3BucketDetails.name
-
resource.s3BucketDetails.tags.key
-
resource.s3BucketDetails.tags.value
-
resource.s3BucketDetails.type
-
service.action.actionType
-
service.action.awsApiCallAction.api
-
service.action.awsApiCallAction.callerType
-
service.action.awsApiCallAction.errorCode
-
service.action.awsApiCallAction.remoteIpDetails.city.cityName
-
service.action.awsApiCallAction.remoteIpDetails.country.countryName
-
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
-
service.action.awsApiCallAction.remoteIpDetails.organization.asn
-
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
-
service.action.awsApiCallAction.serviceName
-
service.action.dnsRequestAction.domain
-
service.action.dnsRequestAction.domainWithSuffix
-
service.action.networkConnectionAction.blocked
-
service.action.networkConnectionAction.connectionDirection
-
service.action.networkConnectionAction.localPortDetails.port
-
service.action.networkConnectionAction.protocol
-
service.action.networkConnectionAction.remoteIpDetails.city.cityName
-
service.action.networkConnectionAction.remoteIpDetails.country.countryName
-
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
-
service.action.networkConnectionAction.remoteIpDetails.organization.asn
-
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
-
service.action.networkConnectionAction.remotePortDetails.port
-
service.action.awsApiCallAction.remoteAccountDetails.affiliated
-
service.action.kubernetesApiCallAction.remoteIpDetails.ipAddressV4
-
service.action.kubernetesApiCallAction.namespace
-
service.action.kubernetesApiCallAction.remoteIpDetails.organization.asn
-
service.action.kubernetesApiCallAction.requestUri
-
service.action.kubernetesApiCallAction.statusCode
-
service.action.networkConnectionAction.localIpDetails.ipAddressV4
-
service.action.networkConnectionAction.protocol
-
service.action.awsApiCallAction.serviceName
-
service.action.awsApiCallAction.remoteAccountDetails.accountId
-
service.additionalInfo.threatListName
-
service.resourceRole
-
resource.eksClusterDetails.name
-
resource.kubernetesDetails.kubernetesWorkloadDetails.name
-
resource.kubernetesDetails.kubernetesWorkloadDetails.namespace
-
resource.kubernetesDetails.kubernetesUserDetails.username
-
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.image
-
resource.kubernetesDetails.kubernetesWorkloadDetails.containers.imagePrefix
-
service.ebsVolumeScanDetails.scanId
-
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.name
-
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.severity
-
service.ebsVolumeScanDetails.scanDetections.threatDetectedByName.threatNames.filePaths.hash
-
resource.ecsClusterDetails.name
-
resource.ecsClusterDetails.taskDetails.containers.image
-
resource.ecsClusterDetails.taskDetails.definitionArn
-
resource.containerDetails.image
-
resource.rdsDbInstanceDetails.dbInstanceIdentifier
-
resource.rdsDbInstanceDetails.dbClusterIdentifier
-
resource.rdsDbInstanceDetails.engine
-
resource.rdsDbUserDetails.user
-
resource.rdsDbInstanceDetails.tags.key
-
resource.rdsDbInstanceDetails.tags.value
-
service.runtimeDetails.process.executableSha256
-
service.runtimeDetails.process.name
-
service.runtimeDetails.process.name
-
resource.lambdaDetails.functionName
-
resource.lambdaDetails.functionArn
-
resource.lambdaDetails.tags.key
-
resource.lambdaDetails.tags.value
-
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseThe idempotency token for the create request.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe tags to be added to a new filter resource.
- On success, responds with
CreateFilterOutputwith field(s):name(Option<String>):The name of the successfully created filter.
- On failure, responds with
SdkError<CreateFilterError>
source§impl Client
impl Client
sourcepub fn create_ip_set(&self) -> CreateIPSetFluentBuilder
pub fn create_ip_set(&self) -> CreateIPSetFluentBuilder
Constructs a fluent builder for the CreateIPSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account that you want to create an IPSet for.
name(impl Into<String>)/set_name(Option<String>):
required: trueThe user-friendly name to identify the IPSet.
Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).
format(IpSetFormat)/set_format(Option<IpSetFormat>):
required: trueThe format of the file that contains the IPSet.
location(impl Into<String>)/set_location(Option<String>):
required: trueThe URI of the file that contains the IPSet.
activate(bool)/set_activate(Option<bool>):
required: trueA Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseThe idempotency token for the create request.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe tags to be added to a new IP set resource.
- On success, responds with
CreateIpSetOutputwith field(s):ip_set_id(Option<String>):The ID of the IPSet resource.
- On failure, responds with
SdkError<CreateIPSetError>
source§impl Client
impl Client
sourcepub fn create_members(&self) -> CreateMembersFluentBuilder
pub fn create_members(&self) -> CreateMembersFluentBuilder
Constructs a fluent builder for the CreateMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account that you want to associate member accounts with.
account_details(AccountDetail)/set_account_details(Option<Vec::<AccountDetail>>):
required: trueA list of account ID and email address pairs of the accounts that you want to associate with the GuardDuty administrator account.
- On success, responds with
CreateMembersOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that include the
accountIdsof the unprocessed accounts and a result string that explains why each was unprocessed.
- On failure, responds with
SdkError<CreateMembersError>
source§impl Client
impl Client
sourcepub fn create_publishing_destination(
&self
) -> CreatePublishingDestinationFluentBuilder
pub fn create_publishing_destination( &self ) -> CreatePublishingDestinationFluentBuilder
Constructs a fluent builder for the CreatePublishingDestination operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the GuardDuty detector associated with the publishing destination.
destination_type(DestinationType)/set_destination_type(Option<DestinationType>):
required: trueThe type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.
destination_properties(DestinationProperties)/set_destination_properties(Option<DestinationProperties>):
required: trueThe properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseThe idempotency token for the request.
- On success, responds with
CreatePublishingDestinationOutputwith field(s):destination_id(Option<String>):The ID of the publishing destination that is created.
- On failure, responds with
SdkError<CreatePublishingDestinationError>
source§impl Client
impl Client
sourcepub fn create_sample_findings(&self) -> CreateSampleFindingsFluentBuilder
pub fn create_sample_findings(&self) -> CreateSampleFindingsFluentBuilder
Constructs a fluent builder for the CreateSampleFindings operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector to create sample findings for.
finding_types(impl Into<String>)/set_finding_types(Option<Vec::<String>>):
required: falseThe types of sample findings to generate.
- On success, responds with
CreateSampleFindingsOutput - On failure, responds with
SdkError<CreateSampleFindingsError>
source§impl Client
impl Client
sourcepub fn create_threat_intel_set(&self) -> CreateThreatIntelSetFluentBuilder
pub fn create_threat_intel_set(&self) -> CreateThreatIntelSetFluentBuilder
Constructs a fluent builder for the CreateThreatIntelSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.
name(impl Into<String>)/set_name(Option<String>):
required: trueA user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
format(ThreatIntelSetFormat)/set_format(Option<ThreatIntelSetFormat>):
required: trueThe format of the file that contains the ThreatIntelSet.
location(impl Into<String>)/set_location(Option<String>):
required: trueThe URI of the file that contains the ThreatIntelSet.
activate(bool)/set_activate(Option<bool>):
required: trueA Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
client_token(impl Into<String>)/set_client_token(Option<String>):
required: falseThe idempotency token for the create request.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: falseThe tags to be added to a new threat list resource.
- On success, responds with
CreateThreatIntelSetOutputwith field(s):threat_intel_set_id(Option<String>):The ID of the ThreatIntelSet resource.
- On failure, responds with
SdkError<CreateThreatIntelSetError>
source§impl Client
impl Client
sourcepub fn decline_invitations(&self) -> DeclineInvitationsFluentBuilder
pub fn decline_invitations(&self) -> DeclineInvitationsFluentBuilder
Constructs a fluent builder for the DeclineInvitations operation.
- The fluent builder is configurable:
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the Amazon Web Services accounts that sent invitations to the current member account that you want to decline invitations from.
- On success, responds with
DeclineInvitationsOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
- On failure, responds with
SdkError<DeclineInvitationsError>
source§impl Client
impl Client
sourcepub fn delete_detector(&self) -> DeleteDetectorFluentBuilder
pub fn delete_detector(&self) -> DeleteDetectorFluentBuilder
Constructs a fluent builder for the DeleteDetector operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that you want to delete.
- On success, responds with
DeleteDetectorOutput - On failure, responds with
SdkError<DeleteDetectorError>
source§impl Client
impl Client
sourcepub fn delete_filter(&self) -> DeleteFilterFluentBuilder
pub fn delete_filter(&self) -> DeleteFilterFluentBuilder
Constructs a fluent builder for the DeleteFilter operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the filter is associated with.
filter_name(impl Into<String>)/set_filter_name(Option<String>):
required: trueThe name of the filter that you want to delete.
- On success, responds with
DeleteFilterOutput - On failure, responds with
SdkError<DeleteFilterError>
source§impl Client
impl Client
sourcepub fn delete_invitations(&self) -> DeleteInvitationsFluentBuilder
pub fn delete_invitations(&self) -> DeleteInvitationsFluentBuilder
Constructs a fluent builder for the DeleteInvitations operation.
- The fluent builder is configurable:
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the Amazon Web Services accounts that sent invitations to the current member account that you want to delete invitations from.
- On success, responds with
DeleteInvitationsOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
- On failure, responds with
SdkError<DeleteInvitationsError>
source§impl Client
impl Client
sourcepub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder
pub fn delete_ip_set(&self) -> DeleteIPSetFluentBuilder
Constructs a fluent builder for the DeleteIPSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector associated with the IPSet.
ip_set_id(impl Into<String>)/set_ip_set_id(Option<String>):
required: trueThe unique ID of the IPSet to delete.
- On success, responds with
DeleteIpSetOutput - On failure, responds with
SdkError<DeleteIPSetError>
source§impl Client
impl Client
sourcepub fn delete_members(&self) -> DeleteMembersFluentBuilder
pub fn delete_members(&self) -> DeleteMembersFluentBuilder
Constructs a fluent builder for the DeleteMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account whose members you want to delete.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the GuardDuty member accounts that you want to delete.
- On success, responds with
DeleteMembersOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):The accounts that could not be processed.
- On failure, responds with
SdkError<DeleteMembersError>
source§impl Client
impl Client
sourcepub fn delete_publishing_destination(
&self
) -> DeletePublishingDestinationFluentBuilder
pub fn delete_publishing_destination( &self ) -> DeletePublishingDestinationFluentBuilder
Constructs a fluent builder for the DeletePublishingDestination operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector associated with the publishing destination to delete.
destination_id(impl Into<String>)/set_destination_id(Option<String>):
required: trueThe ID of the publishing destination to delete.
- On success, responds with
DeletePublishingDestinationOutput - On failure, responds with
SdkError<DeletePublishingDestinationError>
source§impl Client
impl Client
sourcepub fn delete_threat_intel_set(&self) -> DeleteThreatIntelSetFluentBuilder
pub fn delete_threat_intel_set(&self) -> DeleteThreatIntelSetFluentBuilder
Constructs a fluent builder for the DeleteThreatIntelSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the threatIntelSet is associated with.
threat_intel_set_id(impl Into<String>)/set_threat_intel_set_id(Option<String>):
required: trueThe unique ID of the threatIntelSet that you want to delete.
- On success, responds with
DeleteThreatIntelSetOutput - On failure, responds with
SdkError<DeleteThreatIntelSetError>
source§impl Client
impl Client
sourcepub fn describe_malware_scans(&self) -> DescribeMalwareScansFluentBuilder
pub fn describe_malware_scans(&self) -> DescribeMalwareScansFluentBuilder
Constructs a fluent builder for the DescribeMalwareScans operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the request is associated with.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
filter_criteria(FilterCriteria)/set_filter_criteria(Option<FilterCriteria>):
required: falseRepresents the criteria to be used in the filter for describing scan entries.
sort_criteria(SortCriteria)/set_sort_criteria(Option<SortCriteria>):
required: falseRepresents the criteria used for sorting scan entries. The
attributeNameis required and it must bescanStartTime.
- On success, responds with
DescribeMalwareScansOutputwith field(s):scans(Option<Vec::<Scan>>):Contains information about malware scans.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<DescribeMalwareScansError>
source§impl Client
impl Client
sourcepub fn describe_organization_configuration(
&self
) -> DescribeOrganizationConfigurationFluentBuilder
pub fn describe_organization_configuration( &self ) -> DescribeOrganizationConfigurationFluentBuilder
Constructs a fluent builder for the DescribeOrganizationConfiguration operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector to retrieve information about the delegated administrator from.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items that you want in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill
nextTokenin the request with the value ofNextTokenfrom the previous response to continue listing data.
- On success, responds with
DescribeOrganizationConfigurationOutputwith field(s):auto_enable(Option<bool>):Indicates whether GuardDuty is automatically enabled for accounts added to the organization.
Even though this is still supported, we recommend using
AutoEnableOrganizationMembersto achieve the similar results.member_account_limit_reached(Option<bool>):Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator account for your organization.
data_sources(Option<OrganizationDataSourceConfigurationsResult>):Describes which data sources are enabled automatically for member accounts.
features(Option<Vec::<OrganizationFeatureConfigurationResult>>):A list of features that are configured for this organization.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
auto_enable_organization_members(Option<AutoEnableMembers>):Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization.
-
NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. -
ALL: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includesNEWaccounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty. -
NONE: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
-
- On failure, responds with
SdkError<DescribeOrganizationConfigurationError>
source§impl Client
impl Client
sourcepub fn describe_publishing_destination(
&self
) -> DescribePublishingDestinationFluentBuilder
pub fn describe_publishing_destination( &self ) -> DescribePublishingDestinationFluentBuilder
Constructs a fluent builder for the DescribePublishingDestination operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector associated with the publishing destination to retrieve.
destination_id(impl Into<String>)/set_destination_id(Option<String>):
required: trueThe ID of the publishing destination to retrieve.
- On success, responds with
DescribePublishingDestinationOutputwith field(s):destination_id(Option<String>):The ID of the publishing destination.
destination_type(Option<DestinationType>):The type of publishing destination. Currently, only Amazon S3 buckets are supported.
status(Option<PublishingStatus>):The status of the publishing destination.
publishing_failure_start_timestamp(Option<i64>):The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.
destination_properties(Option<DestinationProperties>):A
DestinationPropertiesobject that includes theDestinationArnandKmsKeyArnof the publishing destination.
- On failure, responds with
SdkError<DescribePublishingDestinationError>
source§impl Client
impl Client
sourcepub fn disable_organization_admin_account(
&self
) -> DisableOrganizationAdminAccountFluentBuilder
pub fn disable_organization_admin_account( &self ) -> DisableOrganizationAdminAccountFluentBuilder
Constructs a fluent builder for the DisableOrganizationAdminAccount operation.
- The fluent builder is configurable:
admin_account_id(impl Into<String>)/set_admin_account_id(Option<String>):
required: trueThe Amazon Web Services Account ID for the organizations account to be disabled as a GuardDuty delegated administrator.
- On success, responds with
DisableOrganizationAdminAccountOutput - On failure, responds with
SdkError<DisableOrganizationAdminAccountError>
source§impl Client
impl Client
sourcepub fn disassociate_from_administrator_account(
&self
) -> DisassociateFromAdministratorAccountFluentBuilder
pub fn disassociate_from_administrator_account( &self ) -> DisassociateFromAdministratorAccountFluentBuilder
Constructs a fluent builder for the DisassociateFromAdministratorAccount operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
- On success, responds with
DisassociateFromAdministratorAccountOutput - On failure, responds with
SdkError<DisassociateFromAdministratorAccountError>
source§impl Client
impl Client
sourcepub fn disassociate_from_master_account(
&self
) -> DisassociateFromMasterAccountFluentBuilder
👎Deprecated: This operation is deprecated, use DisassociateFromAdministratorAccount instead
pub fn disassociate_from_master_account( &self ) -> DisassociateFromMasterAccountFluentBuilder
Constructs a fluent builder for the DisassociateFromMasterAccount operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
- On success, responds with
DisassociateFromMasterAccountOutput - On failure, responds with
SdkError<DisassociateFromMasterAccountError>
source§impl Client
impl Client
sourcepub fn disassociate_members(&self) -> DisassociateMembersFluentBuilder
pub fn disassociate_members(&self) -> DisassociateMembersFluentBuilder
Constructs a fluent builder for the DisassociateMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account whose members you want to disassociate from the administrator account.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the GuardDuty member accounts that you want to disassociate from the administrator account.
- On success, responds with
DisassociateMembersOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
- On failure, responds with
SdkError<DisassociateMembersError>
source§impl Client
impl Client
sourcepub fn enable_organization_admin_account(
&self
) -> EnableOrganizationAdminAccountFluentBuilder
pub fn enable_organization_admin_account( &self ) -> EnableOrganizationAdminAccountFluentBuilder
Constructs a fluent builder for the EnableOrganizationAdminAccount operation.
- The fluent builder is configurable:
admin_account_id(impl Into<String>)/set_admin_account_id(Option<String>):
required: trueThe Amazon Web Services account ID for the organization account to be enabled as a GuardDuty delegated administrator.
- On success, responds with
EnableOrganizationAdminAccountOutput - On failure, responds with
SdkError<EnableOrganizationAdminAccountError>
source§impl Client
impl Client
sourcepub fn get_administrator_account(&self) -> GetAdministratorAccountFluentBuilder
pub fn get_administrator_account(&self) -> GetAdministratorAccountFluentBuilder
Constructs a fluent builder for the GetAdministratorAccount operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
- On success, responds with
GetAdministratorAccountOutputwith field(s):administrator(Option<Administrator>):The administrator account details.
- On failure, responds with
SdkError<GetAdministratorAccountError>
source§impl Client
impl Client
sourcepub fn get_coverage_statistics(&self) -> GetCoverageStatisticsFluentBuilder
pub fn get_coverage_statistics(&self) -> GetCoverageStatisticsFluentBuilder
Constructs a fluent builder for the GetCoverageStatistics operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the GuardDuty detector associated to the coverage statistics.
filter_criteria(CoverageFilterCriteria)/set_filter_criteria(Option<CoverageFilterCriteria>):
required: falseRepresents the criteria used to filter the coverage statistics
statistics_type(CoverageStatisticsType)/set_statistics_type(Option<Vec::<CoverageStatisticsType>>):
required: trueRepresents the statistics type used to aggregate the coverage details.
- On success, responds with
GetCoverageStatisticsOutputwith field(s):coverage_statistics(Option<CoverageStatistics>):Represents the count aggregated by the
statusCodeandresourceType.
- On failure, responds with
SdkError<GetCoverageStatisticsError>
source§impl Client
impl Client
sourcepub fn get_detector(&self) -> GetDetectorFluentBuilder
pub fn get_detector(&self) -> GetDetectorFluentBuilder
Constructs a fluent builder for the GetDetector operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that you want to get.
- On success, responds with
GetDetectorOutputwith field(s):created_at(Option<String>):The timestamp of when the detector was created.
finding_publishing_frequency(Option<FindingPublishingFrequency>):The publishing frequency of the finding.
service_role(Option<String>):The GuardDuty service role.
status(Option<DetectorStatus>):The detector status.
updated_at(Option<String>):The last-updated timestamp for the detector.
data_sources(Option<DataSourceConfigurationsResult>):Describes which data sources are enabled for the detector.
tags(Option<HashMap::<String, String>>):The tags of the detector resource.
features(Option<Vec::<DetectorFeatureConfigurationResult>>):Describes the features that have been enabled for the detector.
- On failure, responds with
SdkError<GetDetectorError>
source§impl Client
impl Client
sourcepub fn get_filter(&self) -> GetFilterFluentBuilder
pub fn get_filter(&self) -> GetFilterFluentBuilder
Constructs a fluent builder for the GetFilter operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the filter is associated with.
filter_name(impl Into<String>)/set_filter_name(Option<String>):
required: trueThe name of the filter you want to get.
- On success, responds with
GetFilterOutputwith field(s):name(Option<String>):The name of the filter.
description(Option<String>):The description of the filter.
action(Option<FilterAction>):Specifies the action that is to be applied to the findings that match the filter.
rank(Option<i32>):Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
finding_criteria(Option<FindingCriteria>):Represents the criteria to be used in the filter for querying findings.
tags(Option<HashMap::<String, String>>):The tags of the filter resource.
- On failure, responds with
SdkError<GetFilterError>
source§impl Client
impl Client
sourcepub fn get_findings(&self) -> GetFindingsFluentBuilder
pub fn get_findings(&self) -> GetFindingsFluentBuilder
Constructs a fluent builder for the GetFindings operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.
finding_ids(impl Into<String>)/set_finding_ids(Option<Vec::<String>>):
required: trueThe IDs of the findings that you want to retrieve.
sort_criteria(SortCriteria)/set_sort_criteria(Option<SortCriteria>):
required: falseRepresents the criteria used for sorting findings.
- On success, responds with
GetFindingsOutputwith field(s):findings(Option<Vec::<Finding>>):A list of findings.
- On failure, responds with
SdkError<GetFindingsError>
source§impl Client
impl Client
sourcepub fn get_findings_statistics(&self) -> GetFindingsStatisticsFluentBuilder
pub fn get_findings_statistics(&self) -> GetFindingsStatisticsFluentBuilder
Constructs a fluent builder for the GetFindingsStatistics operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector that specifies the GuardDuty service whose findings’ statistics you want to retrieve.
finding_statistic_types(FindingStatisticType)/set_finding_statistic_types(Option<Vec::<FindingStatisticType>>):
required: trueThe types of finding statistics to retrieve.
finding_criteria(FindingCriteria)/set_finding_criteria(Option<FindingCriteria>):
required: falseRepresents the criteria that is used for querying findings.
- On success, responds with
GetFindingsStatisticsOutputwith field(s):finding_statistics(Option<FindingStatistics>):The finding statistics object.
- On failure, responds with
SdkError<GetFindingsStatisticsError>
source§impl Client
impl Client
sourcepub fn get_invitations_count(&self) -> GetInvitationsCountFluentBuilder
pub fn get_invitations_count(&self) -> GetInvitationsCountFluentBuilder
Constructs a fluent builder for the GetInvitationsCount operation.
- The fluent builder takes no input, just
sendit. - On success, responds with
GetInvitationsCountOutputwith field(s):invitations_count(Option<i32>):The number of received invitations.
- On failure, responds with
SdkError<GetInvitationsCountError>
source§impl Client
impl Client
sourcepub fn get_ip_set(&self) -> GetIPSetFluentBuilder
pub fn get_ip_set(&self) -> GetIPSetFluentBuilder
Constructs a fluent builder for the GetIPSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the IPSet is associated with.
ip_set_id(impl Into<String>)/set_ip_set_id(Option<String>):
required: trueThe unique ID of the IPSet to retrieve.
- On success, responds with
GetIpSetOutputwith field(s):name(Option<String>):The user-friendly name for the IPSet.
format(Option<IpSetFormat>):The format of the file that contains the IPSet.
location(Option<String>):The URI of the file that contains the IPSet.
status(Option<IpSetStatus>):The status of IPSet file that was uploaded.
tags(Option<HashMap::<String, String>>):The tags of the IPSet resource.
- On failure, responds with
SdkError<GetIPSetError>
source§impl Client
impl Client
sourcepub fn get_malware_scan_settings(&self) -> GetMalwareScanSettingsFluentBuilder
pub fn get_malware_scan_settings(&self) -> GetMalwareScanSettingsFluentBuilder
Constructs a fluent builder for the GetMalwareScanSettings operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the scan setting is associated with.
- On success, responds with
GetMalwareScanSettingsOutputwith field(s):scan_resource_criteria(Option<ScanResourceCriteria>):Represents the criteria to be used in the filter for scanning resources.
ebs_snapshot_preservation(Option<EbsSnapshotPreservation>):An enum value representing possible snapshot preservation settings.
- On failure, responds with
SdkError<GetMalwareScanSettingsError>
source§impl Client
impl Client
sourcepub fn get_master_account(&self) -> GetMasterAccountFluentBuilder
👎Deprecated: This operation is deprecated, use GetAdministratorAccount instead
pub fn get_master_account(&self) -> GetMasterAccountFluentBuilder
Constructs a fluent builder for the GetMasterAccount operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
- On success, responds with
GetMasterAccountOutputwith field(s):master(Option<Master>):The administrator account details.
- On failure, responds with
SdkError<GetMasterAccountError>
source§impl Client
impl Client
sourcepub fn get_member_detectors(&self) -> GetMemberDetectorsFluentBuilder
pub fn get_member_detectors(&self) -> GetMemberDetectorsFluentBuilder
Constructs a fluent builder for the GetMemberDetectors operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe detector ID for the administrator account.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueThe account ID of the member account.
- On success, responds with
GetMemberDetectorsOutputwith field(s):member_data_source_configurations(Option<Vec::<MemberDataSourceConfiguration>>):An object that describes which data sources are enabled for a member account.
unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.
- On failure, responds with
SdkError<GetMemberDetectorsError>
source§impl Client
impl Client
sourcepub fn get_members(&self) -> GetMembersFluentBuilder
pub fn get_members(&self) -> GetMembersFluentBuilder
Constructs a fluent builder for the GetMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account whose members you want to retrieve.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the GuardDuty member accounts that you want to describe.
- On success, responds with
GetMembersOutputwith field(s):members(Option<Vec::<Member>>):A list of members.
unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
- On failure, responds with
SdkError<GetMembersError>
source§impl Client
impl Client
sourcepub fn get_remaining_free_trial_days(
&self
) -> GetRemainingFreeTrialDaysFluentBuilder
pub fn get_remaining_free_trial_days( &self ) -> GetRemainingFreeTrialDaysFluentBuilder
Constructs a fluent builder for the GetRemainingFreeTrialDays operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty member account.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: falseA list of account identifiers of the GuardDuty member account.
- On success, responds with
GetRemainingFreeTrialDaysOutputwith field(s):accounts(Option<Vec::<AccountFreeTrialInfo>>):The member accounts which were included in a request and were processed successfully.
unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):The member account that was included in a request but for which the request could not be processed.
- On failure, responds with
SdkError<GetRemainingFreeTrialDaysError>
source§impl Client
impl Client
sourcepub fn get_threat_intel_set(&self) -> GetThreatIntelSetFluentBuilder
pub fn get_threat_intel_set(&self) -> GetThreatIntelSetFluentBuilder
Constructs a fluent builder for the GetThreatIntelSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the threatIntelSet is associated with.
threat_intel_set_id(impl Into<String>)/set_threat_intel_set_id(Option<String>):
required: trueThe unique ID of the threatIntelSet that you want to get.
- On success, responds with
GetThreatIntelSetOutputwith field(s):name(Option<String>):A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.
format(Option<ThreatIntelSetFormat>):The format of the threatIntelSet.
location(Option<String>):The URI of the file that contains the ThreatIntelSet.
status(Option<ThreatIntelSetStatus>):The status of threatIntelSet file uploaded.
tags(Option<HashMap::<String, String>>):The tags of the threat list resource.
- On failure, responds with
SdkError<GetThreatIntelSetError>
source§impl Client
impl Client
sourcepub fn get_usage_statistics(&self) -> GetUsageStatisticsFluentBuilder
pub fn get_usage_statistics(&self) -> GetUsageStatisticsFluentBuilder
Constructs a fluent builder for the GetUsageStatistics operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.
usage_statistic_type(UsageStatisticType)/set_usage_statistic_type(Option<UsageStatisticType>):
required: trueThe type of usage statistics to retrieve.
usage_criteria(UsageCriteria)/set_usage_criteria(Option<UsageCriteria>):
required: trueRepresents the criteria used for querying usage.
unit(impl Into<String>)/set_unit(Option<String>):
required: falseThe currency unit you would like to view your usage statistics in. Current valid values are USD.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
- On success, responds with
GetUsageStatisticsOutputwith field(s):usage_statistics(Option<UsageStatistics>):The usage statistics object. If a UsageStatisticType was provided, the objects representing other types will be null.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<GetUsageStatisticsError>
source§impl Client
impl Client
sourcepub fn invite_members(&self) -> InviteMembersFluentBuilder
pub fn invite_members(&self) -> InviteMembersFluentBuilder
Constructs a fluent builder for the InviteMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty account that you want to invite members with.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the accounts that you want to invite to GuardDuty as members.
disable_email_notification(bool)/set_disable_email_notification(Option<bool>):
required: falseA Boolean value that specifies whether you want to disable email notification to the accounts that you are inviting to GuardDuty as members.
message(impl Into<String>)/set_message(Option<String>):
required: falseThe invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.
- On success, responds with
InviteMembersOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
- On failure, responds with
SdkError<InviteMembersError>
source§impl Client
impl Client
sourcepub fn list_coverage(&self) -> ListCoverageFluentBuilder
pub fn list_coverage(&self) -> ListCoverageFluentBuilder
Constructs a fluent builder for the ListCoverage operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector whose coverage details you want to retrieve.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
filter_criteria(CoverageFilterCriteria)/set_filter_criteria(Option<CoverageFilterCriteria>):
required: falseRepresents the criteria used to filter the coverage details.
sort_criteria(CoverageSortCriteria)/set_sort_criteria(Option<CoverageSortCriteria>):
required: falseRepresents the criteria used to sort the coverage details.
- On success, responds with
ListCoverageOutputwith field(s):resources(Option<Vec::<CoverageResource>>):A list of resources and their attributes providing cluster details.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListCoverageError>
source§impl Client
impl Client
sourcepub fn list_detectors(&self) -> ListDetectorsFluentBuilder
pub fn list_detectors(&self) -> ListDetectorsFluentBuilder
Constructs a fluent builder for the ListDetectors operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- On success, responds with
ListDetectorsOutputwith field(s):detector_ids(Option<Vec::<String>>):A list of detector IDs.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListDetectorsError>
source§impl Client
impl Client
sourcepub fn list_filters(&self) -> ListFiltersFluentBuilder
pub fn list_filters(&self) -> ListFiltersFluentBuilder
Constructs a fluent builder for the ListFilters operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the filter is associated with.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- On success, responds with
ListFiltersOutputwith field(s):filter_names(Option<Vec::<String>>):A list of filter names.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListFiltersError>
source§impl Client
impl Client
sourcepub fn list_findings(&self) -> ListFindingsFluentBuilder
pub fn list_findings(&self) -> ListFindingsFluentBuilder
Constructs a fluent builder for the ListFindings operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector that specifies the GuardDuty service whose findings you want to list.
finding_criteria(FindingCriteria)/set_finding_criteria(Option<FindingCriteria>):
required: falseRepresents the criteria used for querying findings. Valid values include:
-
JSON field name
-
accountId
-
region
-
confidence
-
id
-
resource.accessKeyDetails.accessKeyId
-
resource.accessKeyDetails.principalId
-
resource.accessKeyDetails.userName
-
resource.accessKeyDetails.userType
-
resource.instanceDetails.iamInstanceProfile.id
-
resource.instanceDetails.imageId
-
resource.instanceDetails.instanceId
-
resource.instanceDetails.networkInterfaces.ipv6Addresses
-
resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
-
resource.instanceDetails.networkInterfaces.publicDnsName
-
resource.instanceDetails.networkInterfaces.publicIp
-
resource.instanceDetails.networkInterfaces.securityGroups.groupId
-
resource.instanceDetails.networkInterfaces.securityGroups.groupName
-
resource.instanceDetails.networkInterfaces.subnetId
-
resource.instanceDetails.networkInterfaces.vpcId
-
resource.instanceDetails.tags.key
-
resource.instanceDetails.tags.value
-
resource.resourceType
-
service.action.actionType
-
service.action.awsApiCallAction.api
-
service.action.awsApiCallAction.callerType
-
service.action.awsApiCallAction.remoteIpDetails.city.cityName
-
service.action.awsApiCallAction.remoteIpDetails.country.countryName
-
service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
-
service.action.awsApiCallAction.remoteIpDetails.organization.asn
-
service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
-
service.action.awsApiCallAction.serviceName
-
service.action.dnsRequestAction.domain
-
service.action.dnsRequestAction.domainWithSuffix
-
service.action.networkConnectionAction.blocked
-
service.action.networkConnectionAction.connectionDirection
-
service.action.networkConnectionAction.localPortDetails.port
-
service.action.networkConnectionAction.protocol
-
service.action.networkConnectionAction.remoteIpDetails.country.countryName
-
service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
-
service.action.networkConnectionAction.remoteIpDetails.organization.asn
-
service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
-
service.action.networkConnectionAction.remotePortDetails.port
-
service.additionalInfo.threatListName
-
service.archived
When this attribute is set to ‘true’, only archived findings are listed. When it’s set to ‘false’, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
-
service.resourceRole
-
severity
-
type
-
updatedAt
Type: Timestamp in Unix Epoch millisecond format: 1486685375000
-
sort_criteria(SortCriteria)/set_sort_criteria(Option<SortCriteria>):
required: falseRepresents the criteria used for sorting findings.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- On success, responds with
ListFindingsOutputwith field(s):finding_ids(Option<Vec::<String>>):The IDs of the findings that you’re listing.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListFindingsError>
source§impl Client
impl Client
sourcepub fn list_invitations(&self) -> ListInvitationsFluentBuilder
pub fn list_invitations(&self) -> ListInvitationsFluentBuilder
Constructs a fluent builder for the ListInvitations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- On success, responds with
ListInvitationsOutputwith field(s):invitations(Option<Vec::<Invitation>>):A list of invitation descriptions.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListInvitationsError>
source§impl Client
impl Client
sourcepub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder
pub fn list_ip_sets(&self) -> ListIPSetsFluentBuilder
Constructs a fluent builder for the ListIPSets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the IPSet is associated with.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- On success, responds with
ListIpSetsOutputwith field(s):ip_set_ids(Option<Vec::<String>>):The IDs of the IPSet resources.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListIPSetsError>
source§impl Client
impl Client
sourcepub fn list_members(&self) -> ListMembersFluentBuilder
pub fn list_members(&self) -> ListMembersFluentBuilder
Constructs a fluent builder for the ListMembers operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector the member is associated with.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
only_associated(impl Into<String>)/set_only_associated(Option<String>):
required: falseSpecifies whether to only return associated members or to return all members (including members who haven’t been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using
Create Members.
- On success, responds with
ListMembersOutputwith field(s):members(Option<Vec::<Member>>):A list of members.
The values for
emailandinvitedAtare available only if the member accounts are added by invitation.next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListMembersError>
source§impl Client
impl Client
sourcepub fn list_organization_admin_accounts(
&self
) -> ListOrganizationAdminAccountsFluentBuilder
pub fn list_organization_admin_accounts( &self ) -> ListOrganizationAdminAccountsFluentBuilder
Constructs a fluent builder for the ListOrganizationAdminAccounts operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the
NextTokenvalue returned from the previous request to continue listing results after the first page.
- On success, responds with
ListOrganizationAdminAccountsOutputwith field(s):admin_accounts(Option<Vec::<AdminAccount>>):A list of accounts configured as GuardDuty delegated administrators.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListOrganizationAdminAccountsError>
source§impl Client
impl Client
sourcepub fn list_publishing_destinations(
&self
) -> ListPublishingDestinationsFluentBuilder
pub fn list_publishing_destinations( &self ) -> ListPublishingDestinationsFluentBuilder
Constructs a fluent builder for the ListPublishingDestinations operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector to retrieve publishing destinations for.
max_results(i32)/set_max_results(Option<i32>):
required: falseThe maximum number of results to return in the response.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseA token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the
NextTokenvalue returned from the previous request to continue listing results after the first page.
- On success, responds with
ListPublishingDestinationsOutputwith field(s):destinations(Option<Vec::<Destination>>):A
Destinationsobject that includes information about each publishing destination returned.next_token(Option<String>):A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the
NextTokenvalue returned from the previous request to continue listing results after the first page.
- On failure, responds with
SdkError<ListPublishingDestinationsError>
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) for the given GuardDuty resource.
- On success, responds with
ListTagsForResourceOutputwith field(s):tags(Option<HashMap::<String, String>>):The tags associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_threat_intel_sets(&self) -> ListThreatIntelSetsFluentBuilder
pub fn list_threat_intel_sets(&self) -> ListThreatIntelSetsFluentBuilder
Constructs a fluent builder for the ListThreatIntelSets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that the threatIntelSet is associated with.
max_results(i32)/set_max_results(Option<i32>):
required: falseYou can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
next_token(impl Into<String>)/set_next_token(Option<String>):
required: falseYou can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- On success, responds with
ListThreatIntelSetsOutputwith field(s):threat_intel_set_ids(Option<Vec::<String>>):The IDs of the ThreatIntelSet resources.
next_token(Option<String>):The pagination parameter to be used on the next list operation to retrieve more items.
- On failure, responds with
SdkError<ListThreatIntelSetsError>
source§impl Client
impl Client
sourcepub fn start_malware_scan(&self) -> StartMalwareScanFluentBuilder
pub fn start_malware_scan(&self) -> StartMalwareScanFluentBuilder
Constructs a fluent builder for the StartMalwareScan operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)/set_resource_arn(Option<String>):
required: trueAmazon Resource Name (ARN) of the resource for which you invoked the API.
- On success, responds with
StartMalwareScanOutputwith field(s):scan_id(Option<String>):A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.
- On failure, responds with
SdkError<StartMalwareScanError>
source§impl Client
impl Client
sourcepub fn start_monitoring_members(&self) -> StartMonitoringMembersFluentBuilder
pub fn start_monitoring_members(&self) -> StartMonitoringMembersFluentBuilder
Constructs a fluent builder for the StartMonitoringMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs of the GuardDuty member accounts to start monitoring.
- On success, responds with
StartMonitoringMembersOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
- On failure, responds with
SdkError<StartMonitoringMembersError>
source§impl Client
impl Client
sourcepub fn stop_monitoring_members(&self) -> StopMonitoringMembersFluentBuilder
pub fn stop_monitoring_members(&self) -> StopMonitoringMembersFluentBuilder
Constructs a fluent builder for the StopMonitoringMembers operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector associated with the GuardDuty administrator account that is monitoring member accounts.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of account IDs for the member accounts to stop monitoring.
- On success, responds with
StopMonitoringMembersOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.
- On failure, responds with
SdkError<StopMonitoringMembersError>
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) for the GuardDuty resource to apply a tag to.
tags(impl Into<String>, impl Into<String>)/set_tags(Option<HashMap::<String, String>>):
required: trueThe tags to be added to a resource.
- On success, responds with
TagResourceOutput - On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn unarchive_findings(&self) -> UnarchiveFindingsFluentBuilder
pub fn unarchive_findings(&self) -> UnarchiveFindingsFluentBuilder
Constructs a fluent builder for the UnarchiveFindings operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector associated with the findings to unarchive.
finding_ids(impl Into<String>)/set_finding_ids(Option<Vec::<String>>):
required: trueThe IDs of the findings to unarchive.
- On success, responds with
UnarchiveFindingsOutput - On failure, responds with
SdkError<UnarchiveFindingsError>
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) for the resource to remove tags from.
tag_keys(impl Into<String>)/set_tag_keys(Option<Vec::<String>>):
required: trueThe tag keys to remove from the resource.
- On success, responds with
UntagResourceOutput - On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_detector(&self) -> UpdateDetectorFluentBuilder
pub fn update_detector(&self) -> UpdateDetectorFluentBuilder
Constructs a fluent builder for the UpdateDetector operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector to update.
enable(bool)/set_enable(Option<bool>):
required: falseSpecifies whether the detector is enabled or not enabled.
finding_publishing_frequency(FindingPublishingFrequency)/set_finding_publishing_frequency(Option<FindingPublishingFrequency>):
required: falseAn enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
data_sources(DataSourceConfigurations)/set_data_sources(Option<DataSourceConfigurations>):
required: falseDescribes which data sources will be updated.
There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.
features(DetectorFeatureConfiguration)/set_features(Option<Vec::<DetectorFeatureConfiguration>>):
required: falseProvides the features that will be updated for the detector.
- On success, responds with
UpdateDetectorOutput - On failure, responds with
SdkError<UpdateDetectorError>
source§impl Client
impl Client
sourcepub fn update_filter(&self) -> UpdateFilterFluentBuilder
pub fn update_filter(&self) -> UpdateFilterFluentBuilder
Constructs a fluent builder for the UpdateFilter operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that specifies the GuardDuty service where you want to update a filter.
filter_name(impl Into<String>)/set_filter_name(Option<String>):
required: trueThe name of the filter.
description(impl Into<String>)/set_description(Option<String>):
required: falseThe description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses (
{ },[ ], and( )), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.action(FilterAction)/set_action(Option<FilterAction>):
required: falseSpecifies the action that is to be applied to the findings that match the filter.
rank(i32)/set_rank(Option<i32>):
required: falseSpecifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
finding_criteria(FindingCriteria)/set_finding_criteria(Option<FindingCriteria>):
required: falseRepresents the criteria to be used in the filter for querying findings.
- On success, responds with
UpdateFilterOutputwith field(s):name(Option<String>):The name of the filter.
- On failure, responds with
SdkError<UpdateFilterError>
source§impl Client
impl Client
sourcepub fn update_findings_feedback(&self) -> UpdateFindingsFeedbackFluentBuilder
pub fn update_findings_feedback(&self) -> UpdateFindingsFeedbackFluentBuilder
Constructs a fluent builder for the UpdateFindingsFeedback operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector associated with the findings to update feedback for.
finding_ids(impl Into<String>)/set_finding_ids(Option<Vec::<String>>):
required: trueThe IDs of the findings that you want to mark as useful or not useful.
feedback(Feedback)/set_feedback(Option<Feedback>):
required: trueThe feedback for the finding.
comments(impl Into<String>)/set_comments(Option<String>):
required: falseAdditional feedback about the GuardDuty findings.
- On success, responds with
UpdateFindingsFeedbackOutput - On failure, responds with
SdkError<UpdateFindingsFeedbackError>
source§impl Client
impl Client
sourcepub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder
pub fn update_ip_set(&self) -> UpdateIPSetFluentBuilder
Constructs a fluent builder for the UpdateIPSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe detectorID that specifies the GuardDuty service whose IPSet you want to update.
ip_set_id(impl Into<String>)/set_ip_set_id(Option<String>):
required: trueThe unique ID that specifies the IPSet that you want to update.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe unique ID that specifies the IPSet that you want to update.
location(impl Into<String>)/set_location(Option<String>):
required: falseThe updated URI of the file that contains the IPSet.
activate(bool)/set_activate(Option<bool>):
required: falseThe updated Boolean value that specifies whether the IPSet is active or not.
- On success, responds with
UpdateIpSetOutput - On failure, responds with
SdkError<UpdateIPSetError>
source§impl Client
impl Client
sourcepub fn update_malware_scan_settings(
&self
) -> UpdateMalwareScanSettingsFluentBuilder
pub fn update_malware_scan_settings( &self ) -> UpdateMalwareScanSettingsFluentBuilder
Constructs a fluent builder for the UpdateMalwareScanSettings operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe unique ID of the detector that specifies the GuardDuty service where you want to update scan settings.
scan_resource_criteria(ScanResourceCriteria)/set_scan_resource_criteria(Option<ScanResourceCriteria>):
required: falseRepresents the criteria to be used in the filter for selecting resources to scan.
ebs_snapshot_preservation(EbsSnapshotPreservation)/set_ebs_snapshot_preservation(Option<EbsSnapshotPreservation>):
required: falseAn enum value representing possible snapshot preservation settings.
- On success, responds with
UpdateMalwareScanSettingsOutput - On failure, responds with
SdkError<UpdateMalwareScanSettingsError>
source§impl Client
impl Client
sourcepub fn update_member_detectors(&self) -> UpdateMemberDetectorsFluentBuilder
pub fn update_member_detectors(&self) -> UpdateMemberDetectorsFluentBuilder
Constructs a fluent builder for the UpdateMemberDetectors operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe detector ID of the administrator account.
account_ids(impl Into<String>)/set_account_ids(Option<Vec::<String>>):
required: trueA list of member account IDs to be updated.
data_sources(DataSourceConfigurations)/set_data_sources(Option<DataSourceConfigurations>):
required: falseDescribes which data sources will be updated.
features(MemberFeaturesConfiguration)/set_features(Option<Vec::<MemberFeaturesConfiguration>>):
required: falseA list of features that will be updated for the specified member accounts.
- On success, responds with
UpdateMemberDetectorsOutputwith field(s):unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.
- On failure, responds with
SdkError<UpdateMemberDetectorsError>
source§impl Client
impl Client
sourcepub fn update_organization_configuration(
&self
) -> UpdateOrganizationConfigurationFluentBuilder
pub fn update_organization_configuration( &self ) -> UpdateOrganizationConfigurationFluentBuilder
Constructs a fluent builder for the UpdateOrganizationConfiguration operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector that configures the delegated administrator.
auto_enable(bool)/set_auto_enable(Option<bool>):
required: falseRepresents whether or not to automatically enable member accounts in the organization.
Even though this is still supported, we recommend using
AutoEnableOrganizationMembersto achieve the similar results. You must provide a value for eitherautoEnableOrganizationMembersorautoEnable.data_sources(OrganizationDataSourceConfigurations)/set_data_sources(Option<OrganizationDataSourceConfigurations>):
required: falseDescribes which data sources will be updated.
features(OrganizationFeatureConfiguration)/set_features(Option<Vec::<OrganizationFeatureConfiguration>>):
required: falseA list of features that will be configured for the organization.
auto_enable_organization_members(AutoEnableMembers)/set_auto_enable_organization_members(Option<AutoEnableMembers>):
required: falseIndicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either
autoEnableOrganizationMembersorautoEnable.Use one of the following configuration values for
autoEnableOrganizationMembers:-
NEW: Indicates that when a new account joins the organization, they will have GuardDuty enabled automatically. -
ALL: Indicates that all accounts in the organization have GuardDuty enabled automatically. This includesNEWaccounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.It may take up to 24 hours to update the configuration for all the member accounts.
-
NONE: Indicates that GuardDuty will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.
-
- On success, responds with
UpdateOrganizationConfigurationOutput - On failure, responds with
SdkError<UpdateOrganizationConfigurationError>
source§impl Client
impl Client
sourcepub fn update_publishing_destination(
&self
) -> UpdatePublishingDestinationFluentBuilder
pub fn update_publishing_destination( &self ) -> UpdatePublishingDestinationFluentBuilder
Constructs a fluent builder for the UpdatePublishingDestination operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe ID of the detector associated with the publishing destinations to update.
destination_id(impl Into<String>)/set_destination_id(Option<String>):
required: trueThe ID of the publishing destination to update.
destination_properties(DestinationProperties)/set_destination_properties(Option<DestinationProperties>):
required: falseA
DestinationPropertiesobject that includes theDestinationArnandKmsKeyArnof the publishing destination.
- On success, responds with
UpdatePublishingDestinationOutput - On failure, responds with
SdkError<UpdatePublishingDestinationError>
source§impl Client
impl Client
sourcepub fn update_threat_intel_set(&self) -> UpdateThreatIntelSetFluentBuilder
pub fn update_threat_intel_set(&self) -> UpdateThreatIntelSetFluentBuilder
Constructs a fluent builder for the UpdateThreatIntelSet operation.
- The fluent builder is configurable:
detector_id(impl Into<String>)/set_detector_id(Option<String>):
required: trueThe detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.
threat_intel_set_id(impl Into<String>)/set_threat_intel_set_id(Option<String>):
required: trueThe unique ID that specifies the ThreatIntelSet that you want to update.
name(impl Into<String>)/set_name(Option<String>):
required: falseThe unique ID that specifies the ThreatIntelSet that you want to update.
location(impl Into<String>)/set_location(Option<String>):
required: falseThe updated URI of the file that contains the ThreateIntelSet.
activate(bool)/set_activate(Option<bool>):
required: falseThe updated Boolean value that specifies whether the ThreateIntelSet is active or not.
- On success, responds with
UpdateThreatIntelSetOutput - On failure, responds with
SdkError<UpdateThreatIntelSetError>
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_implconfigured. - Identity caching is enabled without a
sleep_implandtime_sourceconfigured. - No
behavior_versionis 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_configis missing an async sleep implementation. If you experience this panic, set thesleep_implon the Config passed into this function to fix it. - This method will panic if the
sdk_configis missing an HTTP connector. If you experience this panic, set thehttp_connectoron the Config passed into this function to fix it. - This method will panic if no
BehaviorVersionis provided. If you experience this panic, setbehavior_versionon the Config or enable thebehavior-version-latestCargo feature.