Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Access
Control List Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.
- Account
Detail Specifies the details of an account to associate with an Amazon Macie administrator account.
- Account
Level Permissions Provides information about the account-level permissions settings that apply to an S3 bucket.
- Admin
Account Provides information about the delegated Amazon Macie administrator account for an organization in Organizations.
- Allow
List Criteria 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.
- Allow
List Status Provides information about the current status of an allow list, which indicates whether Amazon Macie can access and use the list's criteria.
- Allow
List Summary Provides a subset of information about an allow list.
- ApiCall
Details Provides information about an API operation that an entity invoked for an affected resource.
- Assumed
Role 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.
- Automated
Discovery Account Provides information about the status of automated sensitive data discovery for an Amazon Macie account.
- Automated
Discovery Account Update Changes the status of automated sensitive data discovery for an Amazon Macie account.
- Automated
Discovery Account Update Error Provides information about a request that failed to change the status of automated sensitive data discovery for an Amazon Macie account.
- 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
Provides information about an Amazon Web Service that performed an action on an affected resource.
- Batch
GetCustom Data Identifier Summary Provides information about a custom data identifier.
- Block
Public Access 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.
- Bucket
Count ByEffective Permission Provides information about the number of S3 buckets that are publicly accessible due to a combination of permissions settings for each bucket.
- Bucket
Count ByEncryption Type 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.
- Bucket
Count ByShared Access Type 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.
- Bucket
Count Policy Allows Unencrypted Object Uploads 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.
- Bucket
Criteria Additional Properties Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.
- Bucket
Level Permissions Provides information about the bucket-level permissions settings for an S3 bucket.
- Bucket
Metadata 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.
If an error or issue prevents Macie from retrieving and processing metadata from Amazon S3 for the bucket or the bucket's objects, the value for the versioning property is false and the value for most other properties is null or UNKNOWN. Key exceptions are accountId, bucketArn, bucketCreatedAt, bucketName, lastUpdated, and region. To identify the cause, refer to the errorCode and errorMessage values.
- Bucket
Permission Configuration Provides information about the account-level and bucket-level permissions settings for an S3 bucket.
- Bucket
Policy Provides information about the permissions settings of the bucket policy for an S3 bucket.
- Bucket
Public Access Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.
- Bucket
Server Side Encryption 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.
- Bucket
Sort Criteria Specifies criteria for sorting the results of a query for information about S3 buckets.
- Bucket
Statistics BySensitivity 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
Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
- Classification
Details Provides information about a sensitive data finding and the details of the finding.
- Classification
Export Configuration 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.
- Classification
Result Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.
- Classification
Result Status Provides information about the status of a sensitive data finding.
- Classification
Scope Summary 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.
- Criteria
Block ForJob Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 buckets from a classification job.
- Criteria
ForJob Specifies a property- or tag-based condition that defines criteria for including or excluding S3 buckets from a classification job.
- Criterion
Additional Properties 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.
- Custom
Data Identifier Summary Provides information about a custom data identifier.
- Custom
Data Identifiers 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.
- Custom
Detection Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.
- Daily
Schedule Specifies that a classification job runs once a day, every day. This is an empty object.
- Default
Detection Provides information about a type of sensitive data that was detected by a managed data identifier and produced a sensitive data finding.
- Detected
Data Details Specifies 1-10 occurrences of a specific type of sensitive data reported by a finding.
- 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.
- Domain
Details Provides information about the domain name of the device that an entity used to perform an action on an affected resource.
- Federated
User 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
Provides the details of a finding.
- Finding
Action Provides information about an action that occurred for a resource and produced a policy finding.
- Finding
Actor Provides information about an entity that performed an action that produced a policy finding for a resource.
- Finding
Criteria Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
- Finding
Statistics Sort Criteria Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.
- Findings
Filter List Item Provides information about a findings filter.
- Group
Count Provides a group of results for a query that retrieved aggregated statistical data about findings.
- IamUser
Provides information about an Identity and Access Management (IAM) user who performed an action on an affected resource.
- Invitation
Provides information about an Amazon Macie membership invitation.
- IpAddress
Details Provides information about the IP address of the device that an entity used to perform an action on an affected resource.
- IpCity
Provides information about the city that an IP address originated from.
- IpCountry
Provides information about the country that an IP address originated from.
- IpGeo
Location Provides geographic coordinates that indicate where a specified IP address originated from.
- IpOwner
Provides information about the registered owner of an IP address.
- 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.
- JobSchedule
Frequency Specifies the recurrence pattern for running a classification job.
- JobScope
Term 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.
- JobScoping
Block Specifies one or more property- and tag-based conditions that define criteria for including or excluding S3 objects from a classification job.
- JobSummary
Provides information about a classification job, including the current status of the job.
- KeyValue
Pair 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.
- Last
RunError Status 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.
- List
Jobs Filter Criteria Specifies criteria for filtering the results of a request for information about classification jobs.
- List
Jobs Filter Term 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.
- List
Jobs Sort Criteria Specifies criteria for sorting the results of a request for information about classification jobs.
- Managed
Data Identifier Summary Provides information about a managed data identifier. For additional information, see Using managed data identifiers in the Amazon Macie User Guide.
- Matching
Bucket 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.
If an error or issue prevents Macie from retrieving and processing information about the bucket or the bucket's objects, the value for many of these properties is null. Key exceptions are accountId and bucketName. To identify the cause, refer to the errorCode and errorMessage values.
- Matching
Resource Provides statistical data and other information about an Amazon Web Services resource that Amazon Macie monitors and analyzes for your account.
- Member
Provides information about an account that's associated with an Amazon Macie administrator account.
- Monthly
Schedule Specifies a monthly recurrence pattern for running a classification job.
- Object
Count ByEncryption Type 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.
- Object
Level Statistics 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
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.
- Page
Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.
- Policy
Details Provides the details of a policy finding.
- 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
Specifies the location of an occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file.
- Replication
Details 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.
- Resource
Profile Artifact 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.
- Resource
Statistics 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.
- Resources
Affected Provides information about the resources that a finding applies to.
- Retrieval
Configuration Provides information about the access method and settings that are used to retrieve occurrences of sensitive data reported by findings.
- Reveal
Configuration 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.
- 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.
- S3Bucket
Criteria ForJob 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.
- S3Bucket
Definition ForJob 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.
- S3Bucket
Owner Provides information about the Amazon Web Services account that owns an S3 bucket.
- S3Classification
Scope Specifies the S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.
- S3Classification
Scope Exclusion Specifies the names of the S3 buckets that are excluded from automated sensitive data discovery.
- S3Classification
Scope Exclusion Update Specifies S3 buckets to add or remove from the exclusion list defined by the classification scope for an Amazon Macie account.
- S3Classification
Scope Update Specifies changes to the list of S3 buckets that are excluded from automated sensitive data discovery for an Amazon Macie account.
- S3Destination
Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.
- S3Job
Definition 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
Provides information about the S3 object that a finding applies to.
- S3Words
List Provides information about an S3 object that lists specific text to ignore.
- 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.
- Search
Resources Bucket Criteria 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.
- Search
Resources Criteria Specifies a property- or tag-based filter condition for including or excluding Amazon Web Services resources from the query results.
- Search
Resources Criteria Block Specifies property- and tag-based conditions that define filter criteria for including or excluding Amazon Web Services resources from the query results.
- Search
Resources Simple Criterion Specifies a property-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.
- Search
Resources Sort Criteria Specifies criteria for sorting the results of a query for information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
- Search
Resources TagCriterion Specifies a tag-based filter condition that determines which Amazon Web Services resources are included or excluded from the query results.
- Search
Resources TagCriterion Pair 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.
- Security
HubConfiguration 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.
- Sensitive
Data Item Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.
- Sensitivity
Aggregations 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.
- Sensitivity
Inspection Template Excludes 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.
- Sensitivity
Inspection Template Includes 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.
- Sensitivity
Inspection Templates Entry Provides information about the sensitivity inspection template for an Amazon Macie account.
- Server
Side Encryption Provides information about the default server-side encryption settings for an S3 bucket or the encryption settings for an S3 object.
- Service
Limit Specifies a current quota for an Amazon Macie account.
- Session
Context Provides information about a session that was created for an entity that performed an action by using temporary security credentials.
- Session
Context Attributes Provides information about the context in which temporary security credentials were issued to an entity.
- Session
Issuer Provides information about the source and type of temporary security credentials that were issued to an entity.
- Severity
Provides the numerical and qualitative representations of a finding's severity.
- Severity
Level 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.
- Simple
Criterion ForJob Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job.
- Simple
Scope Term Specifies a property-based condition that determines whether an S3 object is included or excluded from a classification job.
- Sort
Criteria Specifies criteria for sorting the results of a request for findings.
- Statistics
Provides processing statistics for a classification job.
- Suppress
Data Identifier 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.
- TagCriterion
ForJob Specifies a tag-based condition that determines whether an S3 bucket is included or excluded from a classification job.
- TagCriterion
Pair ForJob 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.
- TagScope
Term Specifies a tag-based condition that determines whether an S3 object is included or excluded from a classification job.
- TagValue
Pair 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.
- Unprocessed
Account Provides information about an account-related request that hasn't been processed.
- Update
Retrieval Configuration 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.
- Usage
ByAccount Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.
- Usage
Record Provides quota and aggregated usage data for an Amazon Macie account.
- Usage
Statistics Filter Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.
- Usage
Statistics Sort By Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.
- Usage
Total 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.
- User
Identity Provides information about the type and other characteristics of an entity that performed an action on an affected resource.
- User
Identity Root 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.
- User
Paused Details 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.
- Weekly
Schedule Specifies a weekly recurrence pattern for running a classification job.
Enums§
- Admin
Status - When writing a match expression against
AdminStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Allow
List Status Code - When writing a match expression against
AllowListStatusCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Allows
Unencrypted Object Uploads - When writing a match expression against
AllowsUnencryptedObjectUploads
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auto
Enable Mode - When writing a match expression against
AutoEnableMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Automated
Discovery Account Status - When writing a match expression against
AutomatedDiscoveryAccountStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Automated
Discovery Account Update Error Code - When writing a match expression against
AutomatedDiscoveryAccountUpdateErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Automated
Discovery Monitoring Status - When writing a match expression against
AutomatedDiscoveryMonitoringStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Automated
Discovery Status - When writing a match expression against
AutomatedDiscoveryStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Availability
Code - When writing a match expression against
AvailabilityCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Bucket
Metadata Error Code - When writing a match expression against
BucketMetadataErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Classification
Scope Update Operation - When writing a match expression against
ClassificationScopeUpdateOperation
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Currency
- When writing a match expression against
Currency
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Data
Identifier Severity - When writing a match expression against
DataIdentifierSeverity
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Data
Identifier Type - When writing a match expression against
DataIdentifierType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - DayOf
Week - When writing a match expression against
DayOfWeek
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Effective
Permission - When writing a match expression against
EffectivePermission
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Encryption
Type - When writing a match expression against
EncryptionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Error
Code - When writing a match expression against
ErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Finding
Action Type - When writing a match expression against
FindingActionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Finding
Category - When writing a match expression against
FindingCategory
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Finding
Publishing Frequency - When writing a match expression against
FindingPublishingFrequency
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Finding
Statistics Sort Attribute Name - When writing a match expression against
FindingStatisticsSortAttributeName
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Finding
Type - When writing a match expression against
FindingType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Findings
Filter Action - When writing a match expression against
FindingsFilterAction
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - GroupBy
- When writing a match expression against
GroupBy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - IsDefined
InJob - When writing a match expression against
IsDefinedInJob
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - IsMonitored
ByJob - When writing a match expression against
IsMonitoredByJob
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - JobComparator
- When writing a match expression against
JobComparator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - JobStatus
- When writing a match expression against
JobStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - JobType
- When writing a match expression against
JobType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Last
RunError Status Code - When writing a match expression against
LastRunErrorStatusCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - List
Jobs Filter Key - When writing a match expression against
ListJobsFilterKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - List
Jobs Sort Attribute Name - When writing a match expression against
ListJobsSortAttributeName
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Macie
Status - When writing a match expression against
MacieStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Managed
Data Identifier Selector - When writing a match expression against
ManagedDataIdentifierSelector
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - OrderBy
- When writing a match expression against
OrderBy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Origin
Type - When writing a match expression against
OriginType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Relationship
Status - When writing a match expression against
RelationshipStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Retrieval
Mode - When writing a match expression against
RetrievalMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reveal
Request Status - When writing a match expression against
RevealRequestStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reveal
Status - When writing a match expression against
RevealStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scope
Filter Key - When writing a match expression against
ScopeFilterKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Search
Resources Comparator - When writing a match expression against
SearchResourcesComparator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Search
Resources Simple Criterion Key - When writing a match expression against
SearchResourcesSimpleCriterionKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Search
Resources Sort Attribute Name - When writing a match expression against
SearchResourcesSortAttributeName
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Sensitive
Data Item Category - When writing a match expression against
SensitiveDataItemCategory
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Severity
Description - When writing a match expression against
SeverityDescription
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Shared
Access - When writing a match expression against
SharedAccess
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Simple
Criterion KeyFor Job - When writing a match expression against
SimpleCriterionKeyForJob
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Storage
Class - When writing a match expression against
StorageClass
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - TagTarget
- When writing a match expression against
TagTarget
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Time
Range - When writing a match expression against
TimeRange
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Type
- When writing a match expression against
Type
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Unavailability
Reason Code - When writing a match expression against
UnavailabilityReasonCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Unit
- When writing a match expression against
Unit
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Usage
Statistics Filter Comparator - When writing a match expression against
UsageStatisticsFilterComparator
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Usage
Statistics Filter Key - When writing a match expression against
UsageStatisticsFilterKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Usage
Statistics Sort Key - When writing a match expression against
UsageStatisticsSortKey
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Usage
Type - When writing a match expression against
UsageType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - User
Identity Type - When writing a match expression against
UserIdentityType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.