Struct Client 

pub struct Client { /* private fields */ }

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 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_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

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty member account.

    
    
  • administrator_id(impl Into<String>) / set_administrator_id(Option<String>):
    required: true
    

    The account ID of the GuardDuty administrator account whose invitation you’re accepting.

    
    
  • invitation_id(impl Into<String>) / set_invitation_id(Option<String>):
    required: true
    

    The value that is used to validate the administrator account to the member account.

    
    
• On success, responds with AcceptAdministratorInvitationOutput
• On failure, responds with SdkError<AcceptAdministratorInvitationError>

impl Client

pub fn accept_invitation(&self) -> AcceptInvitationFluentBuilder

👎Deprecated: This operation is deprecated, use AcceptAdministratorInvitation instead

Constructs a fluent builder for the AcceptInvitation operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector of the GuardDuty member account.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • master_id(impl Into<String>) / set_master_id(Option<String>):
    required: true
    

    The account ID of the GuardDuty administrator account whose invitation you’re accepting.

    
    
  • invitation_id(impl Into<String>) / set_invitation_id(Option<String>):
    required: true
    

    The value that is used to validate the administrator account to the member account.

    
    
• On success, responds with AcceptInvitationOutput
• On failure, responds with SdkError<AcceptInvitationError>

impl Client

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: true
    

    The ID of the detector that specifies the GuardDuty service whose findings you want to archive.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_ids(impl Into<String>) / set_finding_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the findings that you want to archive.

    
    
• On success, responds with ArchiveFindingsOutput
• On failure, responds with SdkError<ArchiveFindingsError>

impl Client

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: true
    

    A Boolean value that specifies whether the detector is to be enabled.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • finding_publishing_frequency(FindingPublishingFrequency) / set_finding_publishing_frequency(Option<FindingPublishingFrequency>):
    required: false
    

    A value that specifies how frequently updated findings are exported.

    
    
  • data_sources(DataSourceConfigurations) / set_data_sources(Option<DataSourceConfigurations>):
    required: false
    

    Describes 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: false
    

    The tags to be added to a new detector resource.

    
    
  • features(DetectorFeatureConfiguration) / set_features(Option<Vec::<DetectorFeatureConfiguration>>):
    required: false
    

    A list of features that will be configured for the detector.

    
    
• On success, responds with CreateDetectorOutput with 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>

impl Client

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: true
    

    The detector ID associated with the GuardDuty account for which you want to create a filter.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The 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: false
    

    The 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: false
    

    Specifies the action that is to be applied to the findings that match the filter.

    
    
  • rank(i32) / set_rank(Option<i32>):
    required: false
    

    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(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):
    required: true
    

    Represents 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”]

      • Critical: [“9”, “10”]

      For more information, see Findings severity levels in the Amazon GuardDuty User Guide.

    • 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.ipAddressV6

    • 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.dnsRequestAction.vpcOwnerAccountId

    • 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.ipAddressV6

    • 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.remoteIpDetails.ipAddressV6

    • 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.localIpDetails.ipAddressV6

    • 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.executablePath

    • 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: false
    

    The idempotency token for the create request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be added to a new filter resource.

    
    
• On success, responds with CreateFilterOutput with field(s):
  • name(Option<String>):

    The name of the successfully created filter.

• On failure, responds with SdkError<CreateFilterError>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The user-friendly name to identify the IPSet.

    Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

    
    
  • format(IpSetFormat) / set_format(Option<IpSetFormat>):
    required: true
    

    The format of the file that contains the IPSet.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The URI of the file that contains the IPSet.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: true
    

    A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be added to a new IP set resource.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
• On success, responds with CreateIpSetOutput with field(s):
  • ip_set_id(Option<String>):

    The ID of the IPSet resource.

• On failure, responds with SdkError<CreateIPSetError>

impl Client

pub fn create_malware_protection_plan( &self, ) -> CreateMalwareProtectionPlanFluentBuilder

Constructs a fluent builder for the CreateMalwareProtectionPlan operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: true
    

    Amazon Resource Name (ARN) of the IAM role that has the permissions to scan and add tags to the associated protected resource.

    
    
  • protected_resource(CreateProtectedResource) / set_protected_resource(Option<CreateProtectedResource>):
    required: true
    

    Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.

    
    
  • actions(MalwareProtectionPlanActions) / set_actions(Option<MalwareProtectionPlanActions>):
    required: false
    

    Information about whether the tags will be added to the S3 object after scanning.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    Tags added to the Malware Protection plan resource.

    
    
• On success, responds with CreateMalwareProtectionPlanOutput with field(s):
  • malware_protection_plan_id(Option<String>):

    A unique identifier associated with the Malware Protection plan resource.

• On failure, responds with SdkError<CreateMalwareProtectionPlanError>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty account for which you want to associate member accounts.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_details(AccountDetail) / set_account_details(Option<Vec::<AccountDetail>>):
    required: true
    

    A 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 CreateMembersOutput with field(s):
  • unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):

    A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

• On failure, responds with SdkError<CreateMembersError>

impl Client

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: true
    

    The ID of the GuardDuty detector associated with the publishing destination.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • destination_type(DestinationType) / set_destination_type(Option<DestinationType>):
    required: true
    

    The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

    
    
  • destination_properties(DestinationProperties) / set_destination_properties(Option<DestinationProperties>):
    required: true
    

    The 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: false
    

    The idempotency token for the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be added to a new publishing destination resource.

    
    
• On success, responds with CreatePublishingDestinationOutput with field(s):
  • destination_id(Option<String>):

    The ID of the publishing destination that is created.

• On failure, responds with SdkError<CreatePublishingDestinationError>

impl Client

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: true
    

    The ID of the detector for which you need to create sample findings.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_types(impl Into<String>) / set_finding_types(Option<Vec::<String>>):
    required: false
    

    The types of sample findings to generate.

    
    
• On success, responds with CreateSampleFindingsOutput
• On failure, responds with SdkError<CreateSampleFindingsError>

impl Client

pub fn create_threat_entity_set(&self) -> CreateThreatEntitySetFluentBuilder

Constructs a fluent builder for the CreateThreatEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector of the GuardDuty account for which you want to create a threat entity set.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A user-friendly name to identify the threat entity set.

    The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

    
    
  • format(ThreatEntitySetFormat) / set_format(Option<ThreatEntitySetFormat>):
    required: true
    

    The format of the file that contains the threat entity set.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The URI of the file that contains the threat entity set. The format of the Location URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see Format of location URL under Step 2: Adding trusted or threat intelligence data in the Amazon GuardDuty User Guide.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: true
    

    A boolean value that indicates whether GuardDuty should start using the uploaded threat entity set to generate findings.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be added to a new threat entity set resource.

    
    
• On success, responds with CreateThreatEntitySetOutput with field(s):
  • threat_entity_set_id(Option<String>):

    The ID returned by GuardDuty after creation of the threat entity set resource.

• On failure, responds with SdkError<CreateThreatEntitySetError>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A 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: true
    

    The format of the file that contains the ThreatIntelSet.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The URI of the file that contains the ThreatIntelSet.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: true
    

    A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be added to a new threat list resource.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
• On success, responds with CreateThreatIntelSetOutput with field(s):
  • threat_intel_set_id(Option<String>):

    The ID of the ThreatIntelSet resource.

• On failure, responds with SdkError<CreateThreatIntelSetError>

impl Client

pub fn create_trusted_entity_set(&self) -> CreateTrustedEntitySetFluentBuilder

Constructs a fluent builder for the CreateTrustedEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector of the GuardDuty account for which you want to create a trusted entity set.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    A user-friendly name to identify the trusted entity set.

    The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

    
    
  • format(TrustedEntitySetFormat) / set_format(Option<TrustedEntitySetFormat>):
    required: true
    

    The format of the file that contains the trusted entity set.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: true
    

    The URI of the file that contains the threat entity set. The format of the Location URL must be a valid Amazon S3 URL format. Invalid URL formats will result in an error, regardless of whether you activate the entity set or not. For more information about format of the location URLs, see Format of location URL under Step 2: Adding trusted or threat intelligence data in the Amazon GuardDuty User Guide.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: true
    

    A boolean value that indicates whether GuardDuty is to start using the uploaded trusted entity set.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The tags to be added to a new trusted entity set resource.

    
    
• On success, responds with CreateTrustedEntitySetOutput with field(s):
  • trusted_entity_set_id(Option<String>):

    The ID returned by GuardDuty after creation of the trusted entity set resource.

• On failure, responds with SdkError<CreateTrustedEntitySetError>

impl Client

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: true
    

    A 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 DeclineInvitationsOutput with 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>

impl Client

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: true
    

    The unique ID of the detector that you want to delete.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
• On success, responds with DeleteDetectorOutput
• On failure, responds with SdkError<DeleteDetectorError>

impl Client

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: true
    

    The unique ID of the detector that is associated with the filter.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    The name of the filter that you want to delete.

    
    
• On success, responds with DeleteFilterOutput
• On failure, responds with SdkError<DeleteFilterError>

impl Client

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: true
    

    A 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 DeleteInvitationsOutput with 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>

impl Client

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: true
    

    The unique ID of the detector associated with the IPSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • ip_set_id(impl Into<String>) / set_ip_set_id(Option<String>):
    required: true
    

    The unique ID of the IPSet to delete.

    
    
• On success, responds with DeleteIpSetOutput
• On failure, responds with SdkError<DeleteIPSetError>

impl Client

pub fn delete_malware_protection_plan( &self, ) -> DeleteMalwareProtectionPlanFluentBuilder

Constructs a fluent builder for the DeleteMalwareProtectionPlan operation.

• The fluent builder is configurable:
  • malware_protection_plan_id(impl Into<String>) / set_malware_protection_plan_id(Option<String>):
    required: true
    

    A unique identifier associated with Malware Protection plan resource.

    
    
• On success, responds with DeleteMalwareProtectionPlanOutput
• On failure, responds with SdkError<DeleteMalwareProtectionPlanError>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty account whose members you want to delete.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A list of account IDs of the GuardDuty member accounts that you want to delete.

    
    
• On success, responds with DeleteMembersOutput with field(s):
  • unprocessed_accounts(Option<Vec::<UnprocessedAccount>>):

    The accounts that could not be processed.

• On failure, responds with SdkError<DeleteMembersError>

impl Client

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: true
    

    The unique ID of the detector associated with the publishing destination to delete.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • destination_id(impl Into<String>) / set_destination_id(Option<String>):
    required: true
    

    The ID of the publishing destination to delete.

    
    
• On success, responds with DeletePublishingDestinationOutput
• On failure, responds with SdkError<DeletePublishingDestinationError>

impl Client

pub fn delete_threat_entity_set(&self) -> DeleteThreatEntitySetFluentBuilder

Constructs a fluent builder for the DeleteThreatEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector associated with the threat entity set resource.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • threat_entity_set_id(impl Into<String>) / set_threat_entity_set_id(Option<String>):
    required: true
    

    The unique ID that helps GuardDuty identify which threat entity set needs to be deleted.

    
    
• On success, responds with DeleteThreatEntitySetOutput
• On failure, responds with SdkError<DeleteThreatEntitySetError>

impl Client

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: true
    

    The unique ID of the detector that is associated with the threatIntelSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • threat_intel_set_id(impl Into<String>) / set_threat_intel_set_id(Option<String>):
    required: true
    

    The unique ID of the threatIntelSet that you want to delete.

    
    
• On success, responds with DeleteThreatIntelSetOutput
• On failure, responds with SdkError<DeleteThreatIntelSetError>

impl Client

pub fn delete_trusted_entity_set(&self) -> DeleteTrustedEntitySetFluentBuilder

Constructs a fluent builder for the DeleteTrustedEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector associated with the trusted entity set resource.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • trusted_entity_set_id(impl Into<String>) / set_trusted_entity_set_id(Option<String>):
    required: true
    

    The unique ID that helps GuardDuty identify which trusted entity set needs to be deleted.

    
    
• On success, responds with DeleteTrustedEntitySetOutput
• On failure, responds with SdkError<DeleteTrustedEntitySetError>

impl Client

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: true
    

    The unique ID of the detector that the request is associated with.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    You 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: false
    

    You 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: false
    

    Represents the criteria to be used in the filter for describing scan entries.

    
    
  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):
    required: false
    

    Represents the criteria used for sorting scan entries. The attributeName is required and it must be scanStartTime.

    
    
• On success, responds with DescribeMalwareScansOutput with field(s):
  • scans(Option<Vec::<Scan>>):

    Contains information about malware scans associated with GuardDuty Malware Protection for EC2.

  • 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>

impl Client

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: true
    

    The detector ID of the delegated administrator for which you need to retrieve the information.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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 DescribeOrganizationConfigurationOutput with 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 AutoEnableOrganizationMembers to 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 or any of the corresponding protection plans for the member accounts in the organization.

    • NEW: Indicates that when a new account joins the organization, they will have GuardDuty or any of the corresponding protection plans enabled automatically.

    • ALL: Indicates that all accounts in the organization have GuardDuty and any of the corresponding protection plans enabled automatically. This includes NEW accounts that join the organization and accounts that may have been suspended or removed from the organization in GuardDuty.

    • NONE: Indicates that GuardDuty or any of the corresponding protection plans will not be automatically enabled for any account in the organization. The administrator must manage GuardDuty for each account in the organization individually.

      When you update the auto-enable setting from ALL or NEW to NONE, this action doesn’t disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.

• On failure, responds with SdkError<DescribeOrganizationConfigurationError>

impl Client

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: true
    

    The unique ID of the detector associated with the publishing destination to retrieve.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • destination_id(impl Into<String>) / set_destination_id(Option<String>):
    required: true
    

    The ID of the publishing destination to retrieve.

    
    
• On success, responds with DescribePublishingDestinationOutput with 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 DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

  • tags(Option<HashMap::<String, String>>):

    The tags of the publishing destination resource.

• On failure, responds with SdkError<DescribePublishingDestinationError>

impl Client

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: true
    

    The 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>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty member account.

    
    
• On success, responds with DisassociateFromAdministratorAccountOutput
• On failure, responds with SdkError<DisassociateFromAdministratorAccountError>

impl Client

pub fn disassociate_from_master_account( &self, ) -> DisassociateFromMasterAccountFluentBuilder

👎Deprecated: This operation is deprecated, use DisassociateFromAdministratorAccount instead

Constructs a fluent builder for the DisassociateFromMasterAccount operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector of the GuardDuty member account.

    
    
• On success, responds with DisassociateFromMasterAccountOutput
• On failure, responds with SdkError<DisassociateFromMasterAccountError>

impl Client

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: true
    

    The 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: true
    

    A list of account IDs of the GuardDuty member accounts that you want to disassociate from the administrator account.

    
    
• On success, responds with DisassociateMembersOutput with 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>

impl Client

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: true
    

    The 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>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty member account.

    
    
• On success, responds with GetAdministratorAccountOutput with field(s):
  • administrator(Option<Administrator>):

    The administrator account details.

• On failure, responds with SdkError<GetAdministratorAccountError>

impl Client

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: true
    

    The unique ID of the GuardDuty detector.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • filter_criteria(CoverageFilterCriteria) / set_filter_criteria(Option<CoverageFilterCriteria>):
    required: false
    

    Represents the criteria used to filter the coverage statistics.

    
    
  • statistics_type(CoverageStatisticsType) / set_statistics_type(Option<Vec::<CoverageStatisticsType>>):
    required: true
    

    Represents the statistics type used to aggregate the coverage details.

    
    
• On success, responds with GetCoverageStatisticsOutput with field(s):
  • coverage_statistics(Option<CoverageStatistics>):

    Represents the count aggregated by the statusCode and resourceType.

• On failure, responds with SdkError<GetCoverageStatisticsError>

impl Client

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: true
    

    The unique ID of the detector that you want to get.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
• On success, responds with GetDetectorOutput with 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>

impl Client

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: true
    

    The unique ID of the detector that is associated with this filter.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    The name of the filter you want to get.

    
    
• On success, responds with GetFilterOutput with 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>

impl Client

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: true
    

    The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_ids(impl Into<String>) / set_finding_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the findings that you want to retrieve.

    
    
  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):
    required: false
    

    Represents the criteria used for sorting findings.

    
    
• On success, responds with GetFindingsOutput with field(s):
  • findings(Option<Vec::<Finding>>):

    A list of findings.

• On failure, responds with SdkError<GetFindingsError>

impl Client

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: true
    

    The ID of the detector whose findings statistics you want to retrieve.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_statistic_types(FindingStatisticType) / set_finding_statistic_types(Option<Vec::<FindingStatisticType>>):
    required: false
    

    The types of finding statistics to retrieve.

    
    
  • finding_criteria(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):
    required: false
    

    Represents the criteria that is used for querying findings.

    
    
  • group_by(GroupByType) / set_group_by(Option<GroupByType>):
    required: false
    

    Displays the findings statistics grouped by one of the listed valid values.

    
    
  • order_by(OrderBy) / set_order_by(Option<OrderBy>):
    required: false
    

    Displays the sorted findings in the requested order. The default value of orderBy is DESC.

    You can use this parameter only with the groupBy parameter.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to be returned in the response. The default value is 25.

    You can use this parameter only with the groupBy parameter.

    
    
• On success, responds with GetFindingsStatisticsOutput with field(s):
  • finding_statistics(Option<FindingStatistics>):

    The finding statistics object.

  • next_token(Option<String>):

    The pagination parameter to be used on the next list operation to retrieve more items.

    This parameter is currently not supported.

• On failure, responds with SdkError<GetFindingsStatisticsError>

impl Client

pub fn get_invitations_count(&self) -> GetInvitationsCountFluentBuilder

Constructs a fluent builder for the GetInvitationsCount operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetInvitationsCountOutput with field(s):
  • invitations_count(Option<i32>):

    The number of received invitations.

• On failure, responds with SdkError<GetInvitationsCountError>

impl Client

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: true
    

    The unique ID of the detector that is associated with the IPSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • ip_set_id(impl Into<String>) / set_ip_set_id(Option<String>):
    required: true
    

    The unique ID of the IPSet to retrieve.

    
    
• On success, responds with GetIpSetOutput with 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.

  • expected_bucket_owner(Option<String>):

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter. This field appears in the response only if it was provided during IPSet creation or update.

• On failure, responds with SdkError<GetIPSetError>

impl Client

pub fn get_malware_protection_plan( &self, ) -> GetMalwareProtectionPlanFluentBuilder

Constructs a fluent builder for the GetMalwareProtectionPlan operation.

• The fluent builder is configurable:
  • malware_protection_plan_id(impl Into<String>) / set_malware_protection_plan_id(Option<String>):
    required: true
    

    A unique identifier associated with Malware Protection plan resource.

    
    
• On success, responds with GetMalwareProtectionPlanOutput with field(s):
  • arn(Option<String>):

    Amazon Resource Name (ARN) of the protected resource.

  • role(Option<String>):

    Amazon Resource Name (ARN) of the IAM role that includes the permissions to scan and add tags to the associated protected resource.

  • protected_resource(Option<CreateProtectedResource>):

    Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.

  • actions(Option<MalwareProtectionPlanActions>):

    Information about whether the tags will be added to the S3 object after scanning.

  • created_at(Option<DateTime>):

    The timestamp when the Malware Protection plan resource was created.

  • status(Option<MalwareProtectionPlanStatus>):

    Malware Protection plan status.

  • status_reasons(Option<Vec::<MalwareProtectionPlanStatusReason>>):

    Information about the issue code and message associated to the status of your Malware Protection plan.

  • tags(Option<HashMap::<String, String>>):

    Tags added to the Malware Protection plan resource.

• On failure, responds with SdkError<GetMalwareProtectionPlanError>

impl Client

pub fn get_malware_scan(&self) -> GetMalwareScanFluentBuilder

Constructs a fluent builder for the GetMalwareScan operation.

• The fluent builder is configurable:
  • scan_id(impl Into<String>) / set_scan_id(Option<String>):
    required: true
    

    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 success, responds with GetMalwareScanOutput with field(s):
  • scan_id(Option<String>):

    A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

  • detector_id(Option<String>):

    The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

  • admin_detector_id(Option<String>):

    The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId. If the customer is not a GuardDuty customer, this field will not be present..

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

  • resource_arn(Option<String>):

    Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.

  • resource_type(Option<MalwareProtectionResourceType>):

    The type of resource that was scanned for malware.

  • scanned_resources_count(Option<i32>):

    The total number of resources that were successfully scanned. This is dependent on the resource type.

  • skipped_resources_count(Option<i32>):

    The total number of resources that were skipped during the scan.

  • failed_resources_count(Option<i32>):

    The total number of resources that failed to be scanned.

  • scanned_resources(Option<Vec::<ScannedResource>>):

    A list of resources along with their metadata that were scanned as part of the malware scan operation.

  • scan_configuration(Option<ScanConfiguration>):

    Information about the scan configuration used for the malware scan.

  • scan_category(Option<ScanCategory>):

    The category of the malware scan, indicating the type of scan performed.

  • scan_status(Option<MalwareProtectionScanStatus>):

    A value representing the current status of the malware scan.

  • scan_status_reason(Option<ScanStatusReason>):

    Represents the reason for the current scan status, if applicable.

  • scan_type(Option<MalwareProtectionScanType>):

    A value representing the initiator of the scan.

  • scan_started_at(Option<DateTime>):

    The timestamp representing when the malware scan was started.

  • scan_completed_at(Option<DateTime>):

    The timestamp representing when the malware scan was completed.

  • scan_result_details(Option<GetMalwareScanResultDetails>):

    Detailed information about the results of the malware scan, if the scan completed.

• On failure, responds with SdkError<GetMalwareScanError>

impl Client

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: true
    

    The unique ID of the detector that is associated with this scan.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
• On success, responds with GetMalwareScanSettingsOutput with 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>

impl Client

pub fn get_master_account(&self) -> GetMasterAccountFluentBuilder

👎Deprecated: This operation is deprecated, use GetAdministratorAccount instead

Constructs a fluent builder for the GetMasterAccount operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector of the GuardDuty member account.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
• On success, responds with GetMasterAccountOutput with field(s):
  • master(Option<Master>):

    The administrator account details.

• On failure, responds with SdkError<GetMasterAccountError>

impl Client

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: true
    

    The detector ID for the administrator account.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A list of member account IDs.

    
    
• On success, responds with GetMemberDetectorsOutput with 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>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A list of account IDs of the GuardDuty member accounts that you want to describe.

    
    
• On success, responds with GetMembersOutput with 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>

impl Client

pub fn get_organization_statistics( &self, ) -> GetOrganizationStatisticsFluentBuilder

Constructs a fluent builder for the GetOrganizationStatistics operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetOrganizationStatisticsOutput with field(s):
  • organization_details(Option<OrganizationDetails>):

    Information about the statistics report for your organization.

• On failure, responds with SdkError<GetOrganizationStatisticsError>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty member account.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: false
    

    A list of account identifiers of the GuardDuty member account.

    
    
• On success, responds with GetRemainingFreeTrialDaysOutput with 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>

impl Client

pub fn get_threat_entity_set(&self) -> GetThreatEntitySetFluentBuilder

Constructs a fluent builder for the GetThreatEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the detector associated with the threat entity set resource.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • threat_entity_set_id(impl Into<String>) / set_threat_entity_set_id(Option<String>):
    required: true
    

    The unique ID that helps GuardDuty identify the threat entity set.

    
    
• On success, responds with GetThreatEntitySetOutput with field(s):
  • name(Option<String>):

    The name of the threat entity set associated with the specified threatEntitySetId.

  • format(Option<ThreatEntitySetFormat>):

    The format of the file that contains the threat entity set.

  • location(Option<String>):

    The URI of the file that contains the threat entity set.

  • expected_bucket_owner(Option<String>):

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

  • status(Option<ThreatEntitySetStatus>):

    The status of the associated threat entity set.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with the threat entity set resource.

  • created_at(Option<DateTime>):

    The timestamp when the associated threat entity set was created.

  • updated_at(Option<DateTime>):

    The timestamp when the associated threat entity set was updated.

  • error_details(Option<String>):

    The error details when the status is shown as ERROR.

• On failure, responds with SdkError<GetThreatEntitySetError>

impl Client

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: true
    

    The unique ID of the detector that is associated with the threatIntelSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • threat_intel_set_id(impl Into<String>) / set_threat_intel_set_id(Option<String>):
    required: true
    

    The unique ID of the threatIntelSet that you want to get.

    
    
• On success, responds with GetThreatIntelSetOutput with 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.

  • expected_bucket_owner(Option<String>):

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter. This field appears in the response only if it was provided during ThreatIntelSet creation or update.

• On failure, responds with SdkError<GetThreatIntelSetError>

impl Client

pub fn get_trusted_entity_set(&self) -> GetTrustedEntitySetFluentBuilder

Constructs a fluent builder for the GetTrustedEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the GuardDuty detector associated with this trusted entity set.

    
    
  • trusted_entity_set_id(impl Into<String>) / set_trusted_entity_set_id(Option<String>):
    required: true
    

    The unique ID that helps GuardDuty identify the trusted entity set.

    
    
• On success, responds with GetTrustedEntitySetOutput with field(s):
  • name(Option<String>):

    The name of the threat entity set associated with the specified trustedEntitySetId.

  • format(Option<TrustedEntitySetFormat>):

    The format of the file that contains the trusted entity set.

  • location(Option<String>):

    The URI of the file that contains the trusted entity set.

  • expected_bucket_owner(Option<String>):

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

  • status(Option<TrustedEntitySetStatus>):

    The status of the associated trusted entity set.

  • tags(Option<HashMap::<String, String>>):

    The tags associated with trusted entity set resource.

  • created_at(Option<DateTime>):

    The timestamp when the associated trusted entity set was created.

  • updated_at(Option<DateTime>):

    The timestamp when the associated trusted entity set was updated.

  • error_details(Option<String>):

    The error details when the status is shown as ERROR.

• On failure, responds with SdkError<GetTrustedEntitySetError>

impl Client

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: true
    

    The ID of the detector that specifies the GuardDuty service whose usage statistics you want to retrieve.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • usage_statistic_type(UsageStatisticType) / set_usage_statistic_type(Option<UsageStatisticType>):
    required: true
    

    The type of usage statistics to retrieve.

    
    
  • usage_criteria(UsageCriteria) / set_usage_criteria(Option<UsageCriteria>):
    required: true
    

    Represents the criteria used for querying usage.

    
    
  • unit(impl Into<String>) / set_unit(Option<String>):
    required: false
    

    The 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: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 NextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with GetUsageStatisticsOutput with 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>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty account with which you want to invite members.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A 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: false
    

    A 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: false
    

    The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.

    
    
• On success, responds with InviteMembersOutput with 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>

impl Client

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: true
    

    The unique ID of the detector whose coverage details you want to retrieve.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 NextToken value returned from the previous request to continue listing results after the first page.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • filter_criteria(CoverageFilterCriteria) / set_filter_criteria(Option<CoverageFilterCriteria>):
    required: false
    

    Represents the criteria used to filter the coverage details.

    
    
  • sort_criteria(CoverageSortCriteria) / set_sort_criteria(Option<CoverageSortCriteria>):
    required: false
    

    Represents the criteria used to sort the coverage details.

    
    
• On success, responds with ListCoverageOutput with 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>

impl Client

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: false
    

    You 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: false
    

    You 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 ListDetectorsOutput with 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>

impl Client

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: true
    

    The unique ID of the detector that is associated with the filter.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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 ListFiltersOutput with 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>

impl Client

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: true
    

    The ID of the detector that specifies the GuardDuty service whose findings you want to list.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_criteria(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):
    required: false
    

    Represents 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.ebsVolumeScanDetails.scanId

    • service.resourceRole

    • severity

    • type

    • updatedAt

      Type: Timestamp in Unix Epoch millisecond format: 1486685375000

    
    
  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):
    required: false
    

    Represents the criteria used for sorting findings.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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 ListFindingsOutput with 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>

impl Client

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: false
    

    You 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: false
    

    You 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 ListInvitationsOutput with 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>

impl Client

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: true
    

    The unique ID of the detector that is associated with IPSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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 ListIpSetsOutput with 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>

impl Client

pub fn list_malware_protection_plans( &self, ) -> ListMalwareProtectionPlansFluentBuilder

Constructs a fluent builder for the ListMalwareProtectionPlans operation.

• The fluent builder is configurable:
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    You 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. The default page size is 100 plans.

    
    
• On success, responds with ListMalwareProtectionPlansOutput with field(s):
  • malware_protection_plans(Option<Vec::<MalwareProtectionPlanSummary>>):

    A list of unique identifiers associated with each Malware Protection plan.

  • next_token(Option<String>):

    You 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 failure, responds with SdkError<ListMalwareProtectionPlansError>

impl Client

pub fn list_malware_scans(&self) -> ListMalwareScansFluentBuilder

Constructs a fluent builder for the ListMalwareScans operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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 results.

    
    
  • filter_criteria(ListMalwareScansFilterCriteria) / set_filter_criteria(Option<ListMalwareScansFilterCriteria>):
    required: false
    

    Represents the criteria used to filter the malware scan entries.

    
    
  • sort_criteria(SortCriteria) / set_sort_criteria(Option<SortCriteria>):
    required: false
    

    Represents the criteria used for sorting malware scan entries.

    
    
• On success, responds with ListMalwareScansOutput with field(s):
  • scans(Option<Vec::<MalwareScan>>):

    The list of malware scans associated with the provided input parameters.

  • next_token(Option<String>):

    The pagination parameter to be used on the next list operation to retrieve more scans.

• On failure, responds with SdkError<ListMalwareScansError>

impl Client

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: true
    

    The unique ID of the detector that is associated with the member.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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: false
    

    Specifies 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 ListMembersOutput with field(s):
  • members(Option<Vec::<Member>>):

    A list of members.

    The values for email and invitedAt are 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>

impl Client

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: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 NextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with ListOrganizationAdminAccountsOutput with 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>

impl Client

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: true
    

    The detector ID for which you want to retrieve the publishing destination.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return in the response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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 NextToken value returned from the previous request to continue listing results after the first page.

    
    
• On success, responds with ListPublishingDestinationsOutput with field(s):
  • destinations(Option<Vec::<Destination>>):

    A Destinations object 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 NextToken value returned from the previous request to continue listing results after the first page.

• On failure, responds with SdkError<ListPublishingDestinationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) for the given GuardDuty resource.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags associated with the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_threat_entity_sets(&self) -> ListThreatEntitySetsFluentBuilder

Constructs a fluent builder for the ListThreatEntitySets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the GuardDuty detector that is associated with this threat entity set.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    You 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 ListThreatEntitySetsOutput with field(s):
  • threat_entity_set_ids(Option<Vec::<String>>):

    The IDs of the threat entity set 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<ListThreatEntitySetsError>

impl Client

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: true
    

    The unique ID of the detector that is associated with the threatIntelSet.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You 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: false
    

    You 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 ListThreatIntelSetsOutput with 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>

impl Client

pub fn list_trusted_entity_sets(&self) -> ListTrustedEntitySetsFluentBuilder

Constructs a fluent builder for the ListTrustedEntitySets operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the GuardDuty detector that is associated with this threat entity set.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    You 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 ListTrustedEntitySetsOutput with field(s):
  • trusted_entity_set_ids(Option<Vec::<String>>):

    The IDs of the trusted entity set 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<ListTrustedEntitySetsError>

impl Client

pub fn send_object_malware_scan(&self) -> SendObjectMalwareScanFluentBuilder

Constructs a fluent builder for the SendObjectMalwareScan operation.

• The fluent builder is configurable:
  • s3_object(S3ObjectForSendObjectMalwareScan) / set_s3_object(Option<S3ObjectForSendObjectMalwareScan>):
    required: false
    

    The S3 object information for the object you want to scan. The bucket must have a Malware Protection plan configured to use this API.

    
    
• On success, responds with SendObjectMalwareScanOutput
• On failure, responds with SdkError<SendObjectMalwareScanError>

impl Client

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: true
    

    Amazon Resource Name (ARN) of the resource for which you invoked the API.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    The idempotency token for the create request.

    
    
  • scan_configuration(StartMalwareScanConfiguration) / set_scan_configuration(Option<StartMalwareScanConfiguration>):
    required: false
    

    Contains information about the configuration to be used for the malware scan.

    
    
• On success, responds with StartMalwareScanOutput with 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>

impl Client

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: true
    

    The unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A list of account IDs of the GuardDuty member accounts to start monitoring.

    
    
• On success, responds with StartMonitoringMembersOutput with 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>

impl Client

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: true
    

    The unique ID of the detector associated with the GuardDuty administrator account that is monitoring member accounts.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A list of account IDs for the member accounts to stop monitoring.

    
    
• On success, responds with StopMonitoringMembersOutput with 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>

impl Client

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: true
    

    The 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: true
    

    The tags to be added to a resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

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: true
    

    The ID of the detector associated with the findings to unarchive.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_ids(impl Into<String>) / set_finding_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the findings to unarchive.

    
    
• On success, responds with UnarchiveFindingsOutput
• On failure, responds with SdkError<UnarchiveFindingsError>

impl Client

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: true
    

    The Amazon Resource Name (ARN) for the resource to remove tags from.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

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: true
    

    The unique ID of the detector to update.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • enable(bool) / set_enable(Option<bool>):
    required: false
    

    Specifies whether the detector is enabled or not enabled.

    
    
  • finding_publishing_frequency(FindingPublishingFrequency) / set_finding_publishing_frequency(Option<FindingPublishingFrequency>):
    required: false
    

    An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.

    
    
  • data_sources(DataSourceConfigurations) / set_data_sources(Option<DataSourceConfigurations>):
    required: false
    

    Describes 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: false
    

    Provides the features that will be updated for the detector.

    
    
• On success, responds with UpdateDetectorOutput
• On failure, responds with SdkError<UpdateDetectorError>

impl Client

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: true
    

    The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • filter_name(impl Into<String>) / set_filter_name(Option<String>):
    required: true
    

    The name of the filter.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The 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: false
    

    Specifies the action that is to be applied to the findings that match the filter.

    
    
  • rank(i32) / set_rank(Option<i32>):
    required: false
    

    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(FindingCriteria) / set_finding_criteria(Option<FindingCriteria>):
    required: false
    

    Represents the criteria to be used in the filter for querying findings.

    
    
• On success, responds with UpdateFilterOutput with field(s):
  • name(Option<String>):

    The name of the filter.

• On failure, responds with SdkError<UpdateFilterError>

impl Client

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: true
    

    The ID of the detector that is associated with the findings for which you want to update the feedback.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • finding_ids(impl Into<String>) / set_finding_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the findings that you want to mark as useful or not useful.

    
    
  • feedback(Feedback) / set_feedback(Option<Feedback>):
    required: true
    

    The feedback for the finding.

    
    
  • comments(impl Into<String>) / set_comments(Option<String>):
    required: false
    

    Additional feedback about the GuardDuty findings.

    
    
• On success, responds with UpdateFindingsFeedbackOutput
• On failure, responds with SdkError<UpdateFindingsFeedbackError>

impl Client

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: true
    

    The detectorID that specifies the GuardDuty service whose IPSet you want to update.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • ip_set_id(impl Into<String>) / set_ip_set_id(Option<String>):
    required: true
    

    The unique ID that specifies the IPSet that you want to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The unique ID that specifies the IPSet that you want to update.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: false
    

    The updated URI of the file that contains the IPSet.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: false
    

    The updated Boolean value that specifies whether the IPSet is active or not.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
• On success, responds with UpdateIpSetOutput
• On failure, responds with SdkError<UpdateIPSetError>

impl Client

pub fn update_malware_protection_plan( &self, ) -> UpdateMalwareProtectionPlanFluentBuilder

Constructs a fluent builder for the UpdateMalwareProtectionPlan operation.

• The fluent builder is configurable:
  • malware_protection_plan_id(impl Into<String>) / set_malware_protection_plan_id(Option<String>):
    required: true
    

    A unique identifier associated with the Malware Protection plan.

    
    
  • role(impl Into<String>) / set_role(Option<String>):
    required: false
    

    Amazon Resource Name (ARN) of the IAM role with permissions to scan and add tags to the associated protected resource.

    
    
  • actions(MalwareProtectionPlanActions) / set_actions(Option<MalwareProtectionPlanActions>):
    required: false
    

    Information about whether the tags will be added to the S3 object after scanning.

    
    
  • protected_resource(UpdateProtectedResource) / set_protected_resource(Option<UpdateProtectedResource>):
    required: false
    

    Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.

    
    
• On success, responds with UpdateMalwareProtectionPlanOutput
• On failure, responds with SdkError<UpdateMalwareProtectionPlanError>

impl Client

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: true
    

    The unique ID of the detector that specifies the GuardDuty service where you want to update scan settings.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • scan_resource_criteria(ScanResourceCriteria) / set_scan_resource_criteria(Option<ScanResourceCriteria>):
    required: false
    

    Represents the criteria to be used in the filter for selecting resources to scan.

    
    
  • ebs_snapshot_preservation(EbsSnapshotPreservation) / set_ebs_snapshot_preservation(Option<EbsSnapshotPreservation>):
    required: false
    

    An enum value representing possible snapshot preservation settings.

    
    
• On success, responds with UpdateMalwareScanSettingsOutput
• On failure, responds with SdkError<UpdateMalwareScanSettingsError>

impl Client

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: true
    

    The detector ID of the administrator account.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    A list of member account IDs to be updated.

    
    
  • data_sources(DataSourceConfigurations) / set_data_sources(Option<DataSourceConfigurations>):
    required: false
    

    Describes which data sources will be updated.

    
    
  • features(MemberFeaturesConfiguration) / set_features(Option<Vec::<MemberFeaturesConfiguration>>):
    required: false
    

    A list of features that will be updated for the specified member accounts.

    
    
• On success, responds with UpdateMemberDetectorsOutput with 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>

impl Client

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: true
    

    The ID of the detector that configures the delegated administrator.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • auto_enable(bool) / set_auto_enable(Option<bool>):
    required: false
    

    Represents whether to automatically enable member accounts in the organization. This applies to only new member accounts, not the existing member accounts. When a new account joins the organization, the chosen features will be enabled for them by default.

    Even though this is still supported, we recommend using AutoEnableOrganizationMembers to achieve the similar results. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

    
    
  • data_sources(OrganizationDataSourceConfigurations) / set_data_sources(Option<OrganizationDataSourceConfigurations>):
    required: false
    

    Describes which data sources will be updated.

    
    
  • features(OrganizationFeatureConfiguration) / set_features(Option<Vec::<OrganizationFeatureConfiguration>>):
    required: false
    

    A list of features that will be configured for the organization.

    
    
  • auto_enable_organization_members(AutoEnableMembers) / set_auto_enable_organization_members(Option<AutoEnableMembers>):
    required: false
    

    Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. You must provide a value for either autoEnableOrganizationMembers or autoEnable.

    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 includes NEW accounts 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.

      When you update the auto-enable setting from ALL or NEW to NONE, this action doesn’t disable the corresponding option for your existing accounts. This configuration will apply to the new accounts that join the organization. After you update the auto-enable settings, no new account will have the corresponding option as enabled.

    
    
• On success, responds with UpdateOrganizationConfigurationOutput
• On failure, responds with SdkError<UpdateOrganizationConfigurationError>

impl Client

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: true
    

    The ID of the detector associated with the publishing destinations to update.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • destination_id(impl Into<String>) / set_destination_id(Option<String>):
    required: true
    

    The ID of the publishing destination to update.

    
    
  • destination_properties(DestinationProperties) / set_destination_properties(Option<DestinationProperties>):
    required: false
    

    A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

    
    
• On success, responds with UpdatePublishingDestinationOutput
• On failure, responds with SdkError<UpdatePublishingDestinationError>

impl Client

pub fn update_threat_entity_set(&self) -> UpdateThreatEntitySetFluentBuilder

Constructs a fluent builder for the UpdateThreatEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • threat_entity_set_id(impl Into<String>) / set_threat_entity_set_id(Option<String>):
    required: true
    

    The ID returned by GuardDuty after updating the threat entity set resource.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A user-friendly name to identify the trusted entity set.

    The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: false
    

    The URI of the file that contains the trusted entity set.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: false
    

    A boolean value that indicates whether GuardDuty is to start using this updated threat entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.

    
    
• On success, responds with UpdateThreatEntitySetOutput
• On failure, responds with SdkError<UpdateThreatEntitySetError>

impl Client

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: true
    

    The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • threat_intel_set_id(impl Into<String>) / set_threat_intel_set_id(Option<String>):
    required: true
    

    The unique ID that specifies the ThreatIntelSet that you want to update.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The unique ID that specifies the ThreatIntelSet that you want to update.

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: false
    

    The updated URI of the file that contains the ThreateIntelSet.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: false
    

    The updated Boolean value that specifies whether the ThreateIntelSet is active or not.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
• On success, responds with UpdateThreatIntelSetOutput
• On failure, responds with SdkError<UpdateThreatIntelSetError>

impl Client

pub fn update_trusted_entity_set(&self) -> UpdateTrustedEntitySetFluentBuilder

Constructs a fluent builder for the UpdateTrustedEntitySet operation.

• The fluent builder is configurable:
  • detector_id(impl Into<String>) / set_detector_id(Option<String>):
    required: true
    

    The unique ID of the GuardDuty detector associated with the threat entity set that you want to update.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

    
    
  • trusted_entity_set_id(impl Into<String>) / set_trusted_entity_set_id(Option<String>):
    required: true
    

    The ID returned by GuardDuty after updating the trusted entity set resource.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    A user-friendly name to identify the trusted entity set.

    The name of your list can include lowercase letters, uppercase letters, numbers, dash (-), and underscore (_).

    
    
  • location(impl Into<String>) / set_location(Option<String>):
    required: false
    

    The URI of the file that contains the trusted entity set.

    
    
  • expected_bucket_owner(impl Into<String>) / set_expected_bucket_owner(Option<String>):
    required: false
    

    The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

    
    
  • activate(bool) / set_activate(Option<bool>):
    required: false
    

    A boolean value that indicates whether GuardDuty is to start using this updated trusted entity set. After you update an entity set, you will need to activate it again. It might take up to 15 minutes for the updated entity set to be effective.

    
    
• On success, responds with UpdateTrustedEntitySetOutput
• On failure, responds with SdkError<UpdateTrustedEntitySetError>

impl Client

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 and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

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 the sleep_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 the http_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, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.