libZSservicesZSamazonka-maciev2ZSamazonka-maciev2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MacieV2.CreateClassificationJob

Description

Creates and defines the settings for a classification job.

Synopsis

Creating a Request

data CreateClassificationJob Source #

See: newCreateClassificationJob smart constructor.

Constructors

CreateClassificationJob' 

Fields

  • initialRun :: Maybe Bool

    For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

    If you configure the job to run only once, don't specify a value for this property.

  • samplingPercentage :: Maybe Int

    The sampling depth, as a percentage, for the job 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.

  • managedDataIdentifierSelector :: Maybe ManagedDataIdentifierSelector

    The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

    • ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
    • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
    • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
    • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

    If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

  • customDataIdentifierIds :: Maybe [Text]

    An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

  • managedDataIdentifierIds :: Maybe [Text]

    An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

    To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

  • description :: Maybe Text

    A custom description of the job. The description can contain as many as 200 characters.

  • tags :: Maybe (HashMap Text Text)

    A map of key-value pairs that specifies the tags to associate with the job.

    A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

  • scheduleFrequency :: Maybe JobScheduleFrequency

    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 jobType property to ONE_TIME.

  • s3JobDefinition :: S3JobDefinition

    The S3 buckets that contain the objects to analyze, and the scope of that analysis.

  • jobType :: JobType

    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 the scheduleFrequency property.
    • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.
  • clientToken :: Text

    A unique, case-sensitive token that you provide to ensure the idempotency of the request.

  • name :: Text

    A custom name for the job. The name can contain as many as 500 characters.

Instances

Instances details
Eq CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Read CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Show CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Generic CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Associated Types

type Rep CreateClassificationJob :: Type -> Type #

NFData CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Methods

rnf :: CreateClassificationJob -> () #

Hashable CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

ToJSON CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

AWSRequest CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

ToHeaders CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

ToPath CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

ToQuery CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

type Rep CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

type Rep CreateClassificationJob = D1 ('MetaData "CreateClassificationJob" "Amazonka.MacieV2.CreateClassificationJob" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "CreateClassificationJob'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "initialRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "samplingPercentage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "managedDataIdentifierSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManagedDataIdentifierSelector)))) :*: (S1 ('MetaSel ('Just "customDataIdentifierIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "managedDataIdentifierIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "scheduleFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobScheduleFrequency)) :*: S1 ('MetaSel ('Just "s3JobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3JobDefinition))) :*: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType) :*: (S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateClassificationJob Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

newCreateClassificationJob Source #

Create a value of CreateClassificationJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:initialRun:CreateClassificationJob', createClassificationJob_initialRun - For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

If you configure the job to run only once, don't specify a value for this property.

$sel:samplingPercentage:CreateClassificationJob', createClassificationJob_samplingPercentage - The sampling depth, as a percentage, for the job 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.

$sel:managedDataIdentifierSelector:CreateClassificationJob', createClassificationJob_managedDataIdentifierSelector - The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

  • ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
  • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
  • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
  • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

$sel:customDataIdentifierIds:CreateClassificationJob', createClassificationJob_customDataIdentifierIds - An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

$sel:managedDataIdentifierIds:CreateClassificationJob', createClassificationJob_managedDataIdentifierIds - An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

$sel:description:CreateClassificationJob', createClassificationJob_description - A custom description of the job. The description can contain as many as 200 characters.

$sel:tags:CreateClassificationJob', createClassificationJob_tags - A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

$sel:scheduleFrequency:CreateClassificationJob', createClassificationJob_scheduleFrequency - 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 jobType property to ONE_TIME.

$sel:s3JobDefinition:CreateClassificationJob', createClassificationJob_s3JobDefinition - The S3 buckets that contain the objects to analyze, and the scope of that analysis.

$sel:jobType:CreateClassificationJob', createClassificationJob_jobType - 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 the scheduleFrequency property.
  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

$sel:clientToken:CreateClassificationJob', createClassificationJob_clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.

$sel:name:CreateClassificationJob', createClassificationJob_name - A custom name for the job. The name can contain as many as 500 characters.

Request Lenses

createClassificationJob_initialRun :: Lens' CreateClassificationJob (Maybe Bool) Source #

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

If you configure the job to run only once, don't specify a value for this property.

createClassificationJob_samplingPercentage :: Lens' CreateClassificationJob (Maybe Int) Source #

The sampling depth, as a percentage, for the job 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.

createClassificationJob_managedDataIdentifierSelector :: Lens' CreateClassificationJob (Maybe ManagedDataIdentifierSelector) Source #

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

  • ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
  • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
  • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
  • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

createClassificationJob_customDataIdentifierIds :: Lens' CreateClassificationJob (Maybe [Text]) Source #

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

createClassificationJob_managedDataIdentifierIds :: Lens' CreateClassificationJob (Maybe [Text]) Source #

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

createClassificationJob_description :: Lens' CreateClassificationJob (Maybe Text) Source #

A custom description of the job. The description can contain as many as 200 characters.

createClassificationJob_tags :: Lens' CreateClassificationJob (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

createClassificationJob_scheduleFrequency :: Lens' CreateClassificationJob (Maybe JobScheduleFrequency) Source #

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 jobType property to ONE_TIME.

createClassificationJob_s3JobDefinition :: Lens' CreateClassificationJob S3JobDefinition Source #

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

createClassificationJob_jobType :: Lens' CreateClassificationJob JobType Source #

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 the scheduleFrequency property.
  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

createClassificationJob_clientToken :: Lens' CreateClassificationJob Text Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

createClassificationJob_name :: Lens' CreateClassificationJob Text Source #

A custom name for the job. The name can contain as many as 500 characters.

Destructuring the Response

data CreateClassificationJobResponse Source #

See: newCreateClassificationJobResponse smart constructor.

Constructors

CreateClassificationJobResponse' 

Fields

Instances

Instances details
Eq CreateClassificationJobResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Read CreateClassificationJobResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Show CreateClassificationJobResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Generic CreateClassificationJobResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

Associated Types

type Rep CreateClassificationJobResponse :: Type -> Type #

NFData CreateClassificationJobResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

type Rep CreateClassificationJobResponse Source # 
Instance details

Defined in Amazonka.MacieV2.CreateClassificationJob

type Rep CreateClassificationJobResponse = D1 ('MetaData "CreateClassificationJobResponse" "Amazonka.MacieV2.CreateClassificationJob" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "CreateClassificationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateClassificationJobResponse Source #

Create a value of CreateClassificationJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobId:CreateClassificationJobResponse', createClassificationJobResponse_jobId - The unique identifier for the job.

$sel:jobArn:CreateClassificationJobResponse', createClassificationJobResponse_jobArn - The Amazon Resource Name (ARN) of the job.

$sel:httpStatus:CreateClassificationJobResponse', createClassificationJobResponse_httpStatus - The response's http status code.

Response Lenses