macie2/aws.sdk.kotlin.services.macie2.model

Package-level declarations

Types

AcceptInvitationRequest

class AcceptInvitationRequest

AcceptInvitationResponse

class AcceptInvitationResponse

AccessControlList

class AccessControlList

Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.

AccessDeniedException

class AccessDeniedException : Macie2Exception

Provides information about an error that occurred due to insufficient access to a specified resource.

AccountDetail

class AccountDetail

Specifies the details of an account to associate with an Amazon Macie administrator account.

AccountLevelPermissions

class AccountLevelPermissions

Provides information about the account-level permissions settings that apply to an S3 bucket.

AdminAccount

class AdminAccount

Provides information about the delegated Amazon Macie administrator account for an organization in Organizations.

AdminStatus

sealed class AdminStatus

The current status of an account as the delegated Amazon Macie administrator account for an organization in Organizations. Possible values are:

AllowListCriteria

class AllowListCriteria

Specifies the criteria for an allow list. The criteria must specify a regular expression (regex) or an S3 object (s3WordsList). It can't specify both.

AllowListStatus

class AllowListStatus

Provides information about the current status of an allow list, which indicates whether Amazon Macie can access and use the list's criteria.

AllowListStatusCode

sealed class AllowListStatusCode

Indicates the current status of an allow list. Depending on the type of criteria that the list specifies, possible values are:

AllowListSummary

class AllowListSummary

Provides a subset of information about an allow list.

AllowsUnencryptedObjectUploads

sealed class AllowsUnencryptedObjectUploads

ApiCallDetails

class ApiCallDetails

Provides information about an API operation that an entity invoked for an affected resource.

AssumedRole

class AssumedRole

Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the Security Token Service (STS) API.

AutoEnableMode

sealed class AutoEnableMode

Specifies whether to automatically enable automated sensitive data discovery for accounts that are part of an organization in Amazon Macie. Valid values are:

AutomatedDiscoveryAccount

class AutomatedDiscoveryAccount

Provides information about the status of automated sensitive data discovery for an Amazon Macie account.

AutomatedDiscoveryAccountStatus

sealed class AutomatedDiscoveryAccountStatus

The status of automated sensitive data discovery for an Amazon Macie account. Valid values are:

AutomatedDiscoveryAccountUpdate

class AutomatedDiscoveryAccountUpdate

Changes the status of automated sensitive data discovery for an Amazon Macie account.

AutomatedDiscoveryAccountUpdateError

class AutomatedDiscoveryAccountUpdateError

Provides information about a request that failed to change the status of automated sensitive data discovery for an Amazon Macie account.

AutomatedDiscoveryAccountUpdateErrorCode

sealed class AutomatedDiscoveryAccountUpdateErrorCode

The error code that indicates why a request failed to change the status of automated sensitive data discovery for an Amazon Macie account. Possible values are:

AutomatedDiscoveryMonitoringStatus

sealed class AutomatedDiscoveryMonitoringStatus

Specifies whether automated sensitive data discovery is currently configured to analyze objects in an S3 bucket. Possible values are:

AutomatedDiscoveryStatus

sealed class AutomatedDiscoveryStatus

The status of the automated sensitive data discovery configuration for an organization in Amazon Macie or a standalone Macie account. Valid values are:

AvailabilityCode

sealed class AvailabilityCode

Specifies whether occurrences of sensitive data can be retrieved for a finding. Possible values are:

AwsAccount

class AwsAccount

Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for an Amazon Web Services account other than your own account.

AwsService

class AwsService

Provides information about an Amazon Web Service that performed an action on an affected resource.

BatchGetCustomDataIdentifiersRequest

class BatchGetCustomDataIdentifiersRequest

BatchGetCustomDataIdentifiersResponse

class BatchGetCustomDataIdentifiersResponse

BatchGetCustomDataIdentifierSummary

class BatchGetCustomDataIdentifierSummary

Provides information about a custom data identifier.

BatchUpdateAutomatedDiscoveryAccountsRequest

class BatchUpdateAutomatedDiscoveryAccountsRequest

BatchUpdateAutomatedDiscoveryAccountsResponse

class BatchUpdateAutomatedDiscoveryAccountsResponse

BlockPublicAccess

class BlockPublicAccess

Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account or bucket level. For detailed information about each setting, see Blocking public access to your Amazon S3 storage in the Amazon Simple Storage Service User Guide.

BucketCountByEffectivePermission

class BucketCountByEffectivePermission

Provides information about the number of S3 buckets that are publicly accessible due to a combination of permissions settings for each bucket.

BucketCountByEncryptionType

class BucketCountByEncryptionType

Provides information about the number of S3 buckets whose settings do or don't specify default server-side encryption behavior for objects that are added to the buckets. For detailed information about these settings, see Setting default server-side encryption behavior for Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

BucketCountBySharedAccessType

class BucketCountBySharedAccessType

Provides information about the number of S3 buckets that are or aren't shared with other Amazon Web Services accounts, Amazon CloudFront origin access identities (OAIs), or CloudFront origin access controls (OACs). In this data, an Amazon Macie organization is defined as a set of Macie accounts that are centrally managed as a group of related accounts through Organizations or by Macie invitation.

BucketCountPolicyAllowsUnencryptedObjectUploads

class BucketCountPolicyAllowsUnencryptedObjectUploads

Provides information about the number of S3 buckets whose bucket policies do or don't require server-side encryption of objects when objects are added to the buckets.

BucketCriteriaAdditionalProperties

class BucketCriteriaAdditionalProperties

Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.

BucketLevelPermissions

class BucketLevelPermissions

Provides information about the bucket-level permissions settings for an S3 bucket.

BucketMetadata

class BucketMetadata

Provides statistical data and other information about an S3 bucket that Amazon Macie monitors and analyzes for your account. By default, object count and storage size values include data for object parts that are the result of incomplete multipart uploads. For more information, see How Macie monitors Amazon S3 data security in the Amazon Macie User Guide.

BucketMetadataErrorCode

sealed class BucketMetadataErrorCode

The code for an error or issue that prevented Amazon Macie from retrieving and processing information about an S3 bucket and the bucket's objects.

BucketPermissionConfiguration

class BucketPermissionConfiguration

Provides information about the account-level and bucket-level permissions settings for an S3 bucket.

BucketPolicy

class BucketPolicy

Provides information about the permissions settings of the bucket policy for an S3 bucket.

BucketPublicAccess

class BucketPublicAccess

Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.

BucketServerSideEncryption

class BucketServerSideEncryption

Provides information about the default server-side encryption settings for an S3 bucket. For detailed information about these settings, see Setting default server-side encryption behavior for Amazon S3 buckets in the Amazon Simple Storage Service User Guide.

BucketSortCriteria

class BucketSortCriteria

Specifies criteria for sorting the results of a query for information about S3 buckets.

BucketStatisticsBySensitivity

class BucketStatisticsBySensitivity

Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets, grouped by bucket sensitivity score (sensitivityScore). If automated sensitive data discovery is currently disabled for your account, the value for most of these metrics is 0.

Cell

class Cell

Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.

ClassificationDetails

class ClassificationDetails

Provides information about a sensitive data finding and the details of the finding.

ClassificationExportConfiguration

class ClassificationExportConfiguration

Specifies where to store data classification results, and the encryption settings to use when storing results in that location. The location must be an S3 general purpose bucket.

ClassificationResult

class ClassificationResult

Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.

ClassificationResultStatus

class ClassificationResultStatus

Provides information about the status of a sensitive data finding.

ClassificationScopeSummary

class ClassificationScopeSummary

Provides information about the classification scope for an Amazon Macie account. Macie uses the scope's settings when it performs automated sensitive data discovery for the account.

ClassificationScopeUpdateOperation

sealed class ClassificationScopeUpdateOperation

Specifies how to apply changes to the S3 bucket exclusion list defined by the classification scope for an Amazon Macie account. Valid values are:

ConflictException

class ConflictException : Macie2Exception

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateAllowListRequest

class CreateAllowListRequest

CreateAllowListResponse

class CreateAllowListResponse

CreateClassificationJobRequest

class CreateClassificationJobRequest

CreateClassificationJobResponse

class CreateClassificationJobResponse

CreateCustomDataIdentifierRequest

class CreateCustomDataIdentifierRequest

CreateCustomDataIdentifierResponse

class CreateCustomDataIdentifierResponse

CreateFindingsFilterRequest

class CreateFindingsFilterRequest

CreateFindingsFilterResponse

class CreateFindingsFilterResponse

CreateInvitationsRequest

class CreateInvitationsRequest

CreateInvitationsResponse

class CreateInvitationsResponse

CreateMemberRequest

class CreateMemberRequest

CreateMemberResponse

class CreateMemberResponse

CreateSampleFindingsRequest

class CreateSampleFindingsRequest

CreateSampleFindingsResponse

class CreateSampleFindingsResponse

CriteriaBlockForJob

class CriteriaBlockForJob

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.

CriteriaForJob

class CriteriaForJob

Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job.

CriterionAdditionalProperties

class CriterionAdditionalProperties

Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see Fundamentals of filtering findings in the Amazon Macie User Guide.

Currency

sealed class Currency

The type of currency that the data for an Amazon Macie usage metric is reported in. Possible values are:

CustomDataIdentifiers

class CustomDataIdentifiers

Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.

CustomDataIdentifierSummary

class CustomDataIdentifierSummary

Provides information about a custom data identifier.

CustomDetection

class CustomDetection

Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.

DailySchedule

class DailySchedule

Specifies that a classification job runs once a day, every day. This is an empty object.

DataIdentifierSeverity

sealed class DataIdentifierSeverity

The severity of a finding, ranging from LOW, for least severe, to HIGH, for most severe. Valid values are:

DataIdentifierType

sealed class DataIdentifierType

The type of data identifier that detected a specific type of sensitive data in an S3 bucket. Possible values are:

DayOfWeek

sealed class DayOfWeek

DeclineInvitationsRequest

class DeclineInvitationsRequest

DeclineInvitationsResponse

class DeclineInvitationsResponse

DefaultDetection

class DefaultDetection

Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.

DeleteAllowListRequest

class DeleteAllowListRequest

DeleteAllowListResponse

class DeleteAllowListResponse

DeleteCustomDataIdentifierRequest

class DeleteCustomDataIdentifierRequest

DeleteCustomDataIdentifierResponse

class DeleteCustomDataIdentifierResponse

DeleteFindingsFilterRequest

class DeleteFindingsFilterRequest

DeleteFindingsFilterResponse

class DeleteFindingsFilterResponse

DeleteInvitationsRequest

class DeleteInvitationsRequest

DeleteInvitationsResponse

class DeleteInvitationsResponse

DeleteMemberRequest

class DeleteMemberRequest

DeleteMemberResponse

class DeleteMemberResponse

DescribeBucketsRequest

class DescribeBucketsRequest

DescribeBucketsResponse

class DescribeBucketsResponse

DescribeClassificationJobRequest

class DescribeClassificationJobRequest

DescribeClassificationJobResponse

class DescribeClassificationJobResponse

DescribeOrganizationConfigurationRequest

class DescribeOrganizationConfigurationRequest

DescribeOrganizationConfigurationResponse

class DescribeOrganizationConfigurationResponse

DetectedDataDetails

class DetectedDataDetails

Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.

Detection

class Detection

Provides information about a type of sensitive data that Amazon Macie found in an S3 bucket while performing automated sensitive data discovery for an account. The information also specifies the custom or managed data identifier that detected the data. This information is available only if automated sensitive data discovery has been enabled for the account.

DisableMacieRequest

class DisableMacieRequest

DisableMacieResponse

class DisableMacieResponse

DisableOrganizationAdminAccountRequest

class DisableOrganizationAdminAccountRequest

DisableOrganizationAdminAccountResponse

class DisableOrganizationAdminAccountResponse

DisassociateFromAdministratorAccountRequest

class DisassociateFromAdministratorAccountRequest

DisassociateFromAdministratorAccountResponse

class DisassociateFromAdministratorAccountResponse

DisassociateFromMasterAccountRequest

class DisassociateFromMasterAccountRequest

DisassociateFromMasterAccountResponse

class DisassociateFromMasterAccountResponse

DisassociateMemberRequest

class DisassociateMemberRequest

DisassociateMemberResponse

class DisassociateMemberResponse

DomainDetails

class DomainDetails

Provides information about the domain name of the device that an entity used to perform an action on an affected resource.

EffectivePermission

sealed class EffectivePermission

EnableMacieRequest

class EnableMacieRequest

EnableMacieResponse

class EnableMacieResponse

EnableOrganizationAdminAccountRequest

class EnableOrganizationAdminAccountRequest

EnableOrganizationAdminAccountResponse

class EnableOrganizationAdminAccountResponse

EncryptionType

sealed class EncryptionType

The server-side encryption algorithm that was used to encrypt an S3 object or is used by default to encrypt objects that are added to an S3 bucket. Possible values are:

ErrorCode

sealed class ErrorCode

The source of an issue or delay. Possible values are:

FederatedUser

class FederatedUser

Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the Security Token Service (STS) API.

Finding

class Finding

Provides the details of a finding.

FindingAction

class FindingAction

Provides information about an action that occurred for a resource and produced a policy finding.

FindingActionType

sealed class FindingActionType

The type of action that occurred for the resource and produced the policy finding:

FindingActor

class FindingActor

Provides information about an entity that performed an action that produced a policy finding for a resource.

FindingCategory

sealed class FindingCategory

The category of the finding. Possible values are:

FindingCriteria

class FindingCriteria

Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.

FindingPublishingFrequency

sealed class FindingPublishingFrequency

The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events). For more information, see Monitoring and processing findings in the Amazon Macie User Guide. Valid values are:

FindingsFilterAction

sealed class FindingsFilterAction

The action to perform on findings that match the filter criteria. To suppress (automatically archive) findings that match the criteria, set this value to ARCHIVE. Valid values are:

FindingsFilterListItem

class FindingsFilterListItem

Provides information about a findings filter.

FindingStatisticsSortAttributeName

sealed class FindingStatisticsSortAttributeName

The grouping to sort the results by. Valid values are:

FindingStatisticsSortCriteria

class FindingStatisticsSortCriteria

Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.

FindingType

sealed class FindingType

The type of finding. For details about each type, see Types of findings in the Amazon Macie User Guide. Possible values are:

GetAdministratorAccountRequest

class GetAdministratorAccountRequest

GetAdministratorAccountResponse

class GetAdministratorAccountResponse

GetAllowListRequest

class GetAllowListRequest

GetAllowListResponse

class GetAllowListResponse

GetAutomatedDiscoveryConfigurationRequest

class GetAutomatedDiscoveryConfigurationRequest

GetAutomatedDiscoveryConfigurationResponse

class GetAutomatedDiscoveryConfigurationResponse

GetBucketStatisticsRequest

class GetBucketStatisticsRequest

GetBucketStatisticsResponse

class GetBucketStatisticsResponse

GetClassificationExportConfigurationRequest

class GetClassificationExportConfigurationRequest

GetClassificationExportConfigurationResponse

class GetClassificationExportConfigurationResponse

GetClassificationScopeRequest

class GetClassificationScopeRequest

GetClassificationScopeResponse

class GetClassificationScopeResponse

GetCustomDataIdentifierRequest

class GetCustomDataIdentifierRequest

GetCustomDataIdentifierResponse

class GetCustomDataIdentifierResponse

GetFindingsFilterRequest

class GetFindingsFilterRequest

GetFindingsFilterResponse

class GetFindingsFilterResponse

GetFindingsPublicationConfigurationRequest

class GetFindingsPublicationConfigurationRequest

GetFindingsPublicationConfigurationResponse

class GetFindingsPublicationConfigurationResponse

GetFindingsRequest

class GetFindingsRequest

GetFindingsResponse

class GetFindingsResponse

GetFindingStatisticsRequest

class GetFindingStatisticsRequest

GetFindingStatisticsResponse

class GetFindingStatisticsResponse

GetInvitationsCountRequest

class GetInvitationsCountRequest

GetInvitationsCountResponse

class GetInvitationsCountResponse

GetMacieSessionRequest

class GetMacieSessionRequest

GetMacieSessionResponse

class GetMacieSessionResponse

GetMasterAccountRequest

class GetMasterAccountRequest

GetMasterAccountResponse

class GetMasterAccountResponse

GetMemberRequest

class GetMemberRequest

GetMemberResponse

class GetMemberResponse

GetResourceProfileRequest

class GetResourceProfileRequest

GetResourceProfileResponse

class GetResourceProfileResponse

GetRevealConfigurationRequest

class GetRevealConfigurationRequest

GetRevealConfigurationResponse

class GetRevealConfigurationResponse

GetSensitiveDataOccurrencesAvailabilityRequest

class GetSensitiveDataOccurrencesAvailabilityRequest

GetSensitiveDataOccurrencesAvailabilityResponse

class GetSensitiveDataOccurrencesAvailabilityResponse

GetSensitiveDataOccurrencesRequest

class GetSensitiveDataOccurrencesRequest

GetSensitiveDataOccurrencesResponse

class GetSensitiveDataOccurrencesResponse

GetSensitivityInspectionTemplateRequest

class GetSensitivityInspectionTemplateRequest

GetSensitivityInspectionTemplateResponse

class GetSensitivityInspectionTemplateResponse

GetUsageStatisticsRequest

class GetUsageStatisticsRequest

GetUsageStatisticsResponse

class GetUsageStatisticsResponse

GetUsageTotalsRequest

class GetUsageTotalsRequest

GetUsageTotalsResponse

class GetUsageTotalsResponse

GroupBy

sealed class GroupBy

GroupCount

class GroupCount

Provides a group of results for a query that retrieved aggregated statistical data about findings.

IamUser

class IamUser

Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.

InternalServerException

class InternalServerException : Macie2Exception

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

Invitation

class Invitation

Provides information about an Amazon Macie membership invitation.

IpAddressDetails

class IpAddressDetails

Provides information about the IP address of the device that an entity used to perform an action on an affected resource.

IpCity

class IpCity

Provides information about the city that an IP address originated from.

IpCountry

class IpCountry

Provides information about the country that an IP address originated from.

IpGeoLocation

class IpGeoLocation

Provides geographic coordinates that indicate where a specified IP address originated from.

IpOwner

class IpOwner

Provides information about the registered owner of an IP address.

IsDefinedInJob

sealed class IsDefinedInJob

IsMonitoredByJob

sealed class IsMonitoredByJob

JobComparator

sealed class JobComparator

The operator to use in a condition. Depending on the type of condition, possible values are:

JobDetails

class JobDetails

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in an S3 bucket, and, if so, the details of the job that ran most recently.

JobScheduleFrequency

class JobScheduleFrequency

Specifies the recurrence pattern for running a classification job.

JobScopeTerm

class JobScopeTerm

Specifies a property- or tag-based condition that defines criteria for including or excluding S3 objects from a classification job. A JobScopeTerm object can contain only one simpleScopeTerm object or one tagScopeTerm object.

JobScopingBlock

class JobScopingBlock

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job.

JobStatus

sealed class JobStatus

The status of a classification job. Possible values are:

JobSummary

class JobSummary

Provides information about a classification job, including the current status of the job.

JobType

sealed class JobType

The schedule for running a classification job. Valid values are:

KeyValuePair

class KeyValuePair

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

LastRunErrorStatus

class LastRunErrorStatus

Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For information about using logging data to investigate these errors, see Monitoring sensitive data discovery jobs in the Amazon Macie User Guide.

LastRunErrorStatusCode

sealed class LastRunErrorStatusCode

Specifies whether any account- or bucket-level access errors occurred during the run of a one-time classification job or the most recent run of a recurring classification job. Possible values are:

ListAllowListsRequest

class ListAllowListsRequest

ListAllowListsResponse

class ListAllowListsResponse

ListAutomatedDiscoveryAccountsRequest

class ListAutomatedDiscoveryAccountsRequest

ListAutomatedDiscoveryAccountsResponse

class ListAutomatedDiscoveryAccountsResponse

ListClassificationJobsRequest

class ListClassificationJobsRequest

ListClassificationJobsResponse

class ListClassificationJobsResponse

ListClassificationScopesRequest

class ListClassificationScopesRequest

ListClassificationScopesResponse

class ListClassificationScopesResponse

ListCustomDataIdentifiersRequest

class ListCustomDataIdentifiersRequest

ListCustomDataIdentifiersResponse

class ListCustomDataIdentifiersResponse

ListFindingsFiltersRequest

class ListFindingsFiltersRequest

ListFindingsFiltersResponse

class ListFindingsFiltersResponse

ListFindingsRequest

class ListFindingsRequest

ListFindingsResponse

class ListFindingsResponse

ListInvitationsRequest

class ListInvitationsRequest

ListInvitationsResponse

class ListInvitationsResponse

ListJobsFilterCriteria

class ListJobsFilterCriteria

Specifies criteria for filtering the results of a request for information about classification jobs.

ListJobsFilterKey

sealed class ListJobsFilterKey

The property to use to filter the results. Valid values are:

ListJobsFilterTerm

class ListJobsFilterTerm

Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values.

ListJobsSortAttributeName

sealed class ListJobsSortAttributeName

The property to sort the results by. Valid values are:

ListJobsSortCriteria

class ListJobsSortCriteria

Specifies criteria for sorting the results of a request for information about classification jobs.

ListManagedDataIdentifiersRequest

class ListManagedDataIdentifiersRequest

ListManagedDataIdentifiersResponse

class ListManagedDataIdentifiersResponse

ListMembersRequest

class ListMembersRequest

ListMembersResponse

class ListMembersResponse

ListOrganizationAdminAccountsRequest

class ListOrganizationAdminAccountsRequest

ListOrganizationAdminAccountsResponse

class ListOrganizationAdminAccountsResponse

ListResourceProfileArtifactsRequest

class ListResourceProfileArtifactsRequest

ListResourceProfileArtifactsResponse

class ListResourceProfileArtifactsResponse

ListResourceProfileDetectionsRequest

class ListResourceProfileDetectionsRequest

ListResourceProfileDetectionsResponse

class ListResourceProfileDetectionsResponse

ListSensitivityInspectionTemplatesRequest

class ListSensitivityInspectionTemplatesRequest

ListSensitivityInspectionTemplatesResponse

class ListSensitivityInspectionTemplatesResponse

ListTagsForResourceRequest

class ListTagsForResourceRequest

ListTagsForResourceResponse

class ListTagsForResourceResponse

Macie2Exception

open class Macie2Exception : AwsServiceException

Base class for all service related exceptions thrown by the Macie2 client

Macie2Unit

sealed class Macie2Unit

MacieStatus

sealed class MacieStatus

The status of an Amazon Macie account. Valid values are:

ManagedDataIdentifierSelector

sealed class ManagedDataIdentifierSelector

The selection type that determines which managed data identifiers a classification job uses to analyze data. Valid values are:

ManagedDataIdentifierSummary

class ManagedDataIdentifierSummary

Provides information about a managed data identifier. For additional information, see Using managed data identifiers in the Amazon Macie User Guide.

MatchingBucket

class MatchingBucket

MatchingResource

class MatchingResource

Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes for your account.

Member

class Member

Provides information about an account that's associated with an Amazon Macie administrator account.

MonthlySchedule

class MonthlySchedule

Specifies a monthly recurrence pattern for running a classification job.

ObjectCountByEncryptionType

class ObjectCountByEncryptionType

Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.

ObjectLevelStatistics

class ObjectLevelStatistics

Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata or MatchingBucket object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, storage size values are based on the size of the latest version of each applicable object in the bucket.

Occurrences

class Occurrences

Specifies the location of 1-15 occurrences of sensitive data that was detected by a managed data identifier or a custom data identifier and produced a sensitive data finding.

OrderBy

sealed class OrderBy

OriginType

sealed class OriginType

Specifies how Amazon Macie found the sensitive data that produced a finding. Possible values are:

Page

class Page

Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.

PolicyDetails

class PolicyDetails

Provides the details of a policy finding.

PutClassificationExportConfigurationRequest

class PutClassificationExportConfigurationRequest

PutClassificationExportConfigurationResponse

class PutClassificationExportConfigurationResponse

PutFindingsPublicationConfigurationRequest

class PutFindingsPublicationConfigurationRequest

PutFindingsPublicationConfigurationResponse

class PutFindingsPublicationConfigurationResponse

Range

class Range

Specifies the location of an occurrence of sensitive data in an email message or a non-binary text file such as an HTML, TXT, or XML file.

Record

class Record

Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.

RelationshipStatus

sealed class RelationshipStatus

The current status of the relationship between an account and an associated Amazon Macie administrator account. Possible values are:

ReplicationDetails

class ReplicationDetails

Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other Amazon Web Services accounts and, if so, which accounts.

ResourceNotFoundException

class ResourceNotFoundException : Macie2Exception

Provides information about an error that occurred because a specified resource wasn't found.

ResourceProfileArtifact

class ResourceProfileArtifact

Provides information about an S3 object that Amazon Macie selected for analysis while performing automated sensitive data discovery for an account, and the status and results of the analysis. This information is available only if automated sensitive data discovery has been enabled for the account.

ResourcesAffected

class ResourcesAffected

Provides information about the resources that a finding applies to.

ResourceStatistics

class ResourceStatistics

Provides statistical data for sensitive data discovery metrics that apply to an S3 bucket that Amazon Macie monitors and analyzes for an account, if automated sensitive data discovery has been enabled for the account. The data captures the results of automated sensitive data discovery activities that Macie has performed for the bucket.

RetrievalConfiguration

class RetrievalConfiguration

Provides information about the access method and settings that are used to retrieve occurrences of sensitive data reported by findings.

RetrievalMode

sealed class RetrievalMode

The access method to use when retrieving occurrences of sensitive data reported by findings. Valid values are:

RevealConfiguration

class RevealConfiguration

Specifies the status of the Amazon Macie configuration for retrieving occurrences of sensitive data reported by findings, and the Key Management Service (KMS) key to use to encrypt sensitive data that's retrieved. When you enable the configuration for the first time, your request must specify an KMS key. Otherwise, an error occurs.

RevealRequestStatus

sealed class RevealRequestStatus

The status of a request to retrieve occurrences of sensitive data reported by a finding. Possible values are:

RevealStatus

sealed class RevealStatus

The status of the configuration for retrieving occurrences of sensitive data reported by findings. Valid values are:

S3Bucket

class S3Bucket

Provides information about the S3 bucket that a finding applies to. If a quota prevented Amazon Macie from retrieving and processing all the bucket's information prior to generating the finding, the following values are UNKNOWN or null: allowsUnencryptedObjectUploads, defaultServerSideEncryption, publicAccess, and tags.

S3BucketCriteriaForJob

class S3BucketCriteriaForJob

Specifies property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job. Exclude conditions take precedence over include conditions.

S3BucketDefinitionForJob

class S3BucketDefinitionForJob

Specifies an Amazon Web Services account that owns S3 buckets for a classification job to analyze, and one or more specific buckets to analyze for that account.

S3BucketOwner

class S3BucketOwner

Provides information about the Amazon Web Services account that owns an S3 bucket.

S3ClassificationScope

class S3ClassificationScope

Specifies the S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.

S3ClassificationScopeExclusion

class S3ClassificationScopeExclusion

Specifies the names of the S3 buckets that are excluded from automated sensitive data discovery.

S3ClassificationScopeExclusionUpdate

class S3ClassificationScopeExclusionUpdate

Specifies S3 buckets to add or remove from the exclusion list defined by the classification scope for an Amazon Macie account.

S3ClassificationScopeUpdate

class S3ClassificationScopeUpdate

Specifies changes to the list of S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.

S3Destination

class S3Destination

Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

S3JobDefinition

class S3JobDefinition

Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis. The bucket specification can be static (bucketDefinitions) or dynamic (bucketCriteria). If it's static, the job analyzes objects in the same predefined set of buckets each time the job runs. If it's dynamic, the job analyzes objects in any buckets that match the specified criteria each time the job starts to run.

S3Object

class S3Object

Provides information about the S3 object that a finding applies to.

S3WordsList

class S3WordsList

Provides information about an S3 object that lists specific text to ignore.

ScopeFilterKey

sealed class ScopeFilterKey

The property to use in a condition that determines whether an S3 object is included or excluded from a classification job. Valid values are:

Scoping

class Scoping

Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job. Exclude conditions take precedence over include conditions.

SearchResourcesBucketCriteria

class SearchResourcesBucketCriteria

Specifies property- and tag-based conditions that define filter criteria for including or excluding S3 buckets from the query results. Exclude conditions take precedence over include conditions.

SearchResourcesComparator

sealed class SearchResourcesComparator

The operator to use in a condition that filters the results of a query. Valid values are:

SearchResourcesCriteria

class SearchResourcesCriteria

Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.

SearchResourcesCriteriaBlock

class SearchResourcesCriteriaBlock

Specifies property- and tag-based conditions that define filter criteria for including or excluding Amazon Web Services resources from the query results.

SearchResourcesRequest

class SearchResourcesRequest

SearchResourcesResponse

class SearchResourcesResponse

SearchResourcesSimpleCriterion

class SearchResourcesSimpleCriterion

Specifies a property-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

SearchResourcesSimpleCriterionKey

sealed class SearchResourcesSimpleCriterionKey

The property to use in a condition that filters the query results. Valid values are:

SearchResourcesSortAttributeName

sealed class SearchResourcesSortAttributeName

The property to sort the query results by. Valid values are:

SearchResourcesSortCriteria

class SearchResourcesSortCriteria

Specifies criteria for sorting the results of a query for information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

SearchResourcesTagCriterion

class SearchResourcesTagCriterion

Specifies a tag-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.

SearchResourcesTagCriterionPair

class SearchResourcesTagCriterionPair

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based filter condition for a query. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based filter conditions.

SecurityHubConfiguration

class SecurityHubConfiguration

Specifies configuration settings that determine which findings are published to Security Hub automatically. For information about how Macie publishes findings to Security Hub, see Evaluating findings with Security Hub in the Amazon Macie User Guide.

SensitiveDataItem

class SensitiveDataItem

Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.

SensitiveDataItemCategory

sealed class SensitiveDataItemCategory

For a finding, the category of sensitive data that was detected and produced the finding. For a managed data identifier, the category of sensitive data that the managed data identifier detects. Possible values are:

SensitivityAggregations

class SensitivityAggregations

Provides aggregated statistical data for sensitive data discovery metrics that apply to S3 buckets. Each field contains aggregated data for all the buckets that have a sensitivity score (sensitivityScore) of a specified value or within a specified range (BucketStatisticsBySensitivity). If automated sensitive data discovery is currently disabled for your account, the value for most fields is 0.

SensitivityInspectionTemplateExcludes

class SensitivityInspectionTemplateExcludes

Specifies managed data identifiers to exclude (not use) when performing automated sensitive data discovery. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

SensitivityInspectionTemplateIncludes

class SensitivityInspectionTemplateIncludes

Specifies the allow lists, custom data identifiers, and managed data identifiers to include (use) when performing automated sensitive data discovery. The configuration must specify at least one custom data identifier or managed data identifier. For information about the managed data identifiers that Amazon Macie currently provides, see Using managed data identifiers in the Amazon Macie User Guide.

SensitivityInspectionTemplatesEntry

class SensitivityInspectionTemplatesEntry

Provides information about the sensitivity inspection template for an Amazon Macie account.

ServerSideEncryption

class ServerSideEncryption

Provides information about the default server-side encryption settings for an S3 bucket or the encryption settings for an S3 object.

ServiceLimit

class ServiceLimit

Specifies a current quota for an Amazon Macie account.

ServiceQuotaExceededException

class ServiceQuotaExceededException : Macie2Exception

Provides information about an error that occurred due to one or more service quotas for an account.

SessionContext

class SessionContext

Provides information about a session that was created for an entity that performed an action by using temporary security credentials.

SessionContextAttributes

class SessionContextAttributes

Provides information about the context in which temporary security credentials were issued to an entity.

SessionIssuer

class SessionIssuer

Provides information about the source and type of temporary security credentials that were issued to an entity.

Severity

class Severity

Provides the numerical and qualitative representations of a finding's severity.

SeverityDescription

sealed class SeverityDescription

The qualitative representation of the finding's severity. Possible values are:

SeverityLevel

class SeverityLevel

Specifies a severity level for findings that a custom data identifier produces. A severity level determines which severity is assigned to the findings, based on the number of occurrences of text that match the custom data identifier's detection criteria.

SharedAccess

sealed class SharedAccess

SimpleCriterionForJob

class SimpleCriterionForJob

Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job.

SimpleCriterionKeyForJob

sealed class SimpleCriterionKeyForJob

The property to use in a condition that determines whether an S3 bucket is included or excluded from a classification job. Valid values are:

SimpleScopeTerm

class SimpleScopeTerm

Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.

SortCriteria

class SortCriteria

Specifies criteria for sorting the results of a request for findings.

Statistics

class Statistics

Provides processing statistics for a classification job.

StorageClass

sealed class StorageClass

The storage class of the S3 object. Possible values are:

SuppressDataIdentifier

class SuppressDataIdentifier

Specifies a custom data identifier or managed data identifier that detected a type of sensitive data to exclude from an S3 bucket's sensitivity score.

TagCriterionForJob

class TagCriterionForJob

Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job.

TagCriterionPairForJob

class TagCriterionPairForJob

Specifies a tag key, a tag value, or a tag key and value (as a pair) to use in a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based conditions.

TagResourceRequest

class TagResourceRequest

TagResourceResponse

class TagResourceResponse

TagScopeTerm

class TagScopeTerm

Specifies a tag-based condition that determines whether an S3 object is included or excluded from a classification job.

TagTarget

sealed class TagTarget

The type of object to apply a tag-based condition to. Valid values are:

TagValuePair

class TagValuePair

Specifies a tag key or tag key and value pair to use in a tag-based condition that determines whether an S3 object is included or excluded from a classification job. Tag keys and values are case sensitive. Also, Amazon Macie doesn't support use of partial values or wildcard characters in tag-based conditions.

TestCustomDataIdentifierRequest

class TestCustomDataIdentifierRequest

TestCustomDataIdentifierResponse

class TestCustomDataIdentifierResponse

ThrottlingException

class ThrottlingException : Macie2Exception

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

TimeRange

sealed class TimeRange

An inclusive time period that Amazon Macie usage data applies to. Possible values are:

Type

sealed class Type

UnavailabilityReasonCode

sealed class UnavailabilityReasonCode

Specifies why occurrences of sensitive data can't be retrieved for a finding. Possible values are:

UnprocessableEntityException

class UnprocessableEntityException : Macie2Exception

Provides information about an error that occurred due to an unprocessable entity.

UnprocessedAccount

class UnprocessedAccount

Provides information about an account-related request that hasn't been processed.

UntagResourceRequest

class UntagResourceRequest

UntagResourceResponse

class UntagResourceResponse

UpdateAllowListRequest

class UpdateAllowListRequest

UpdateAllowListResponse

class UpdateAllowListResponse

UpdateAutomatedDiscoveryConfigurationRequest

class UpdateAutomatedDiscoveryConfigurationRequest

UpdateAutomatedDiscoveryConfigurationResponse

class UpdateAutomatedDiscoveryConfigurationResponse

UpdateClassificationJobRequest

class UpdateClassificationJobRequest

UpdateClassificationJobResponse

class UpdateClassificationJobResponse

UpdateClassificationScopeRequest

class UpdateClassificationScopeRequest

UpdateClassificationScopeResponse

class UpdateClassificationScopeResponse

UpdateFindingsFilterRequest

class UpdateFindingsFilterRequest

UpdateFindingsFilterResponse

class UpdateFindingsFilterResponse

UpdateMacieSessionRequest

class UpdateMacieSessionRequest

UpdateMacieSessionResponse

class UpdateMacieSessionResponse

UpdateMemberSessionRequest

class UpdateMemberSessionRequest

UpdateMemberSessionResponse

class UpdateMemberSessionResponse

UpdateOrganizationConfigurationRequest

class UpdateOrganizationConfigurationRequest

UpdateOrganizationConfigurationResponse

class UpdateOrganizationConfigurationResponse

UpdateResourceProfileDetectionsRequest

class UpdateResourceProfileDetectionsRequest

UpdateResourceProfileDetectionsResponse

class UpdateResourceProfileDetectionsResponse

UpdateResourceProfileRequest

class UpdateResourceProfileRequest

UpdateResourceProfileResponse

class UpdateResourceProfileResponse

UpdateRetrievalConfiguration

class UpdateRetrievalConfiguration

Specifies the access method and settings to use when retrieving occurrences of sensitive data reported by findings. If your request specifies an Identity and Access Management (IAM) role to assume, Amazon Macie verifies that the role exists and the attached policies are configured correctly. If there's an issue, Macie returns an error. For information about addressing the issue, see Configuration options for retrieving sensitive data samples in the Amazon Macie User Guide.

UpdateRevealConfigurationRequest

class UpdateRevealConfigurationRequest

UpdateRevealConfigurationResponse

class UpdateRevealConfigurationResponse

UpdateSensitivityInspectionTemplateRequest

class UpdateSensitivityInspectionTemplateRequest

UpdateSensitivityInspectionTemplateResponse

class UpdateSensitivityInspectionTemplateResponse

UsageByAccount

class UsageByAccount

Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.

UsageRecord

class UsageRecord

Provides quota and aggregated usage data for an Amazon Macie account.

UsageStatisticsFilter

class UsageStatisticsFilter

Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.

UsageStatisticsFilterComparator

sealed class UsageStatisticsFilterComparator

The operator to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:

UsageStatisticsFilterKey

sealed class UsageStatisticsFilterKey

The field to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:

UsageStatisticsSortBy

class UsageStatisticsSortBy

Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.

UsageStatisticsSortKey

sealed class UsageStatisticsSortKey

The field to use to sort the results of a query for Amazon Macie account quotas and usage data. Valid values are:

UsageTotal

class UsageTotal

Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.

UsageType

sealed class UsageType

The name of an Amazon Macie usage metric for an account. Possible values are:

UserIdentity

class UserIdentity

Provides information about the type and other characteristics of an entity that performed an action on an affected resource.

UserIdentityRoot

class UserIdentityRoot

Provides information about an Amazon Web Services account and entity that performed an action on an affected resource. The action was performed using the credentials for your Amazon Web Services account.

UserIdentityType

sealed class UserIdentityType

The type of entity that performed the action on the affected resource. Possible values are:

UserPausedDetails

class UserPausedDetails

Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.

ValidationException

class ValidationException : Macie2Exception

Provides information about an error that occurred due to a syntax error in a request.

WeeklySchedule

class WeeklySchedule

Specifies a weekly recurrence pattern for running a classification job.