ClassificationJobState class
Input properties used for looking up and filtering ClassificationJob resources.
Constructors
-
ClassificationJobState({Input<
String?> ? createdAt, Input<List< ? customDataIdentifierIds, Input<String> ?>String?> ? description, Input<bool?> ? initialRun, Input<String?> ? jobArn, Input<String?> ? jobId, Input<String?> ? jobStatus, Input<String?> ? jobType, Input<String?> ? name, Input<String?> ? namePrefix, Input<String?> ? region, Input<ClassificationJobS3JobDefinition?> ? s3JobDefinition, Input<int?> ? samplingPercentage, Input<ClassificationJobScheduleFrequency?> ? scheduleFrequency, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>List< ? userPausedDetails})ClassificationJobUserPausedDetail> ?> -
Creates a new ClassificationJobState.
createdAtThe date and time, in UTC and extended RFC 3339 format, when the job was created.customDataIdentifierIdsThe custom data identifiers to use for data analysis and classification.descriptionA custom description of the job. The description can contain as many as 200 characters.initialRunSpecifies whether to analyze all existing, eligible objects immediately after the job is created.jobArnOptional.jobIdOptional.jobStatusThe status for the job. Valid values are:CANCELLED,RUNNINGandUSER_PAUSEDjobTypeThe schedule for running the job. Valid values are:ONE_TIME- Run the job only once. If you specify this value, don't specify a value for thescheduleFrequencyproperty.SCHEDULED- Run the job on a daily, weekly, or monthly basis. If you specify this value, use thescheduleFrequencyproperty to define the recurrence pattern for the job.nameA custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.namePrefixCreates a unique name beginning with the specified prefix. Conflicts withname.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.s3JobDefinitionThe S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)samplingPercentageThe sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.scheduleFrequencyThe recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for thejobTypeproperty toONE_TIME. (documented below)tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.userPausedDetailsIf the current status of the job isUSER_PAUSED, specifies when the job was paused and when the job or job run will expire and be canceled if it isn't resumed. This value is present only if the value forjob-statusisUSER_PAUSED.const -
ClassificationJobState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
createdAt
→ Input<
String?> ? -
The date and time, in UTC and extended RFC 3339 format, when the job was created.
final
-
customDataIdentifierIds
→ Input<
List< ?String> ?> -
The custom data identifiers to use for data analysis and classification.
final
-
description
→ Input<
String?> ? -
A custom description of the job. The description can contain as many as 200 characters.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
initialRun
→ Input<
bool?> ? -
Specifies whether to analyze all existing, eligible objects immediately after the job is created.
final
-
jobArn
→ Input<
String?> ? -
final
-
jobId
→ Input<
String?> ? -
final
-
jobStatus
→ Input<
String?> ? -
The status for the job. Valid values are:
CANCELLED,RUNNINGandUSER_PAUSEDfinal -
jobType
→ Input<
String?> ? -
The schedule for running the job. Valid values are:
ONE_TIME- Run the job only once. If you specify this value, don't specify a value for thescheduleFrequencyproperty.SCHEDULED- Run the job on a daily, weekly, or monthly basis. If you specify this value, use thescheduleFrequencyproperty to define the recurrence pattern for the job.final -
name
→ Input<
String?> ? -
A custom name for the job. The name can contain as many as 500 characters. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.final -
namePrefix
→ Input<
String?> ? -
Creates a unique name beginning with the specified prefix. Conflicts with
name.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
s3JobDefinition
→ Input<
ClassificationJobS3JobDefinition?> ? -
The S3 buckets that contain the objects to analyze, and the scope of that analysis. (documented below)
final
-
samplingPercentage
→ Input<
int?> ? -
The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
final
-
scheduleFrequency
→ Input<
ClassificationJobScheduleFrequency?> ? -
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the
jobTypeproperty toONE_TIME. (documented below)final -
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
userPausedDetails
→ Input<
List< ?ClassificationJobUserPausedDetail> ?> -
If the current status of the job is
USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be canceled if it isn't resumed. This value is present only if the value forjob-statusisUSER_PAUSED.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited