libZSservicesZSamazonka-dmsZSamazonka-dms
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.DMS.StartReplicationTaskAssessmentRun

Description

Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

Synopsis

Creating a Request

data StartReplicationTaskAssessmentRun Source #

See: newStartReplicationTaskAssessmentRun smart constructor.

Constructors

StartReplicationTaskAssessmentRun' 

Fields

  • includeOnly :: Maybe [Text]

    Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

    You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation.

    To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

  • resultKmsKeyArn :: Maybe Text

    ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

  • resultLocationFolder :: Maybe Text

    Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

  • resultEncryptionMode :: Maybe Text

    Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

    • "SSE_S3" – The server-side encryption provided as a default by Amazon S3.
    • "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.
  • exclude :: Maybe [Text]

    Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

    You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation.

    To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

  • replicationTaskArn :: Text

    Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

  • serviceAccessRoleArn :: Text

    ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

  • resultLocationBucket :: Text

    Amazon S3 bucket where you want DMS to store the results of this assessment run.

  • assessmentRunName :: Text

    Unique name to identify the assessment run.

Instances

Instances details
Eq StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Read StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Show StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Generic StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Associated Types

type Rep StartReplicationTaskAssessmentRun :: Type -> Type #

NFData StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Hashable StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

ToJSON StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

AWSRequest StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

ToHeaders StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

ToPath StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

ToQuery StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

type Rep StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

type Rep StartReplicationTaskAssessmentRun = D1 ('MetaData "StartReplicationTaskAssessmentRun" "Amazonka.DMS.StartReplicationTaskAssessmentRun" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "StartReplicationTaskAssessmentRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "includeOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "resultKmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "resultLocationFolder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resultEncryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "exclude") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "replicationTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "serviceAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "resultLocationBucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "assessmentRunName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse StartReplicationTaskAssessmentRun Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

newStartReplicationTaskAssessmentRun Source #

Create a value of StartReplicationTaskAssessmentRun 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:includeOnly:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_includeOnly - Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

$sel:resultKmsKeyArn:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_resultKmsKeyArn - ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

$sel:resultLocationFolder:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_resultLocationFolder - Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

$sel:resultEncryptionMode:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_resultEncryptionMode - Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

  • "SSE_S3" – The server-side encryption provided as a default by Amazon S3.
  • "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.

$sel:exclude:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_exclude - Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

$sel:replicationTaskArn:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_replicationTaskArn - Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

$sel:serviceAccessRoleArn:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_serviceAccessRoleArn - ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

$sel:resultLocationBucket:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_resultLocationBucket - Amazon S3 bucket where you want DMS to store the results of this assessment run.

$sel:assessmentRunName:StartReplicationTaskAssessmentRun', startReplicationTaskAssessmentRun_assessmentRunName - Unique name to identify the assessment run.

Request Lenses

startReplicationTaskAssessmentRun_includeOnly :: Lens' StartReplicationTaskAssessmentRun (Maybe [Text]) Source #

Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

You can't set a value for IncludeOnly if you also set a value for Exclude in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

startReplicationTaskAssessmentRun_resultKmsKeyArn :: Lens' StartReplicationTaskAssessmentRun (Maybe Text) Source #

ARN of a custom KMS encryption key that you specify when you set ResultEncryptionMode to "SSE_KMS".

startReplicationTaskAssessmentRun_resultLocationFolder :: Lens' StartReplicationTaskAssessmentRun (Maybe Text) Source #

Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

startReplicationTaskAssessmentRun_resultEncryptionMode :: Lens' StartReplicationTaskAssessmentRun (Maybe Text) Source #

Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:

  • "SSE_S3" – The server-side encryption provided as a default by Amazon S3.
  • "SSE_KMS" – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.

startReplicationTaskAssessmentRun_exclude :: Lens' StartReplicationTaskAssessmentRun (Maybe [Text]) Source #

Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by ReplicationTaskArn.

You can't set a value for Exclude if you also set a value for IncludeOnly in the API operation.

To identify the names of the default individual assessments that DMS supports for the associated migration task, run the DescribeApplicableIndividualAssessments operation using its own ReplicationTaskArn request parameter.

startReplicationTaskAssessmentRun_replicationTaskArn :: Lens' StartReplicationTaskAssessmentRun Text Source #

Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

startReplicationTaskAssessmentRun_serviceAccessRoleArn :: Lens' StartReplicationTaskAssessmentRun Text Source #

ARN of the service role needed to start the assessment run. The role must allow the iam:PassRole action.

startReplicationTaskAssessmentRun_resultLocationBucket :: Lens' StartReplicationTaskAssessmentRun Text Source #

Amazon S3 bucket where you want DMS to store the results of this assessment run.

Destructuring the Response

data StartReplicationTaskAssessmentRunResponse Source #

Constructors

StartReplicationTaskAssessmentRunResponse' 

Fields

Instances

Instances details
Eq StartReplicationTaskAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Read StartReplicationTaskAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Show StartReplicationTaskAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

Generic StartReplicationTaskAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

NFData StartReplicationTaskAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

type Rep StartReplicationTaskAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.DMS.StartReplicationTaskAssessmentRun

type Rep StartReplicationTaskAssessmentRunResponse = D1 ('MetaData "StartReplicationTaskAssessmentRunResponse" "Amazonka.DMS.StartReplicationTaskAssessmentRun" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "StartReplicationTaskAssessmentRunResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "replicationTaskAssessmentRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicationTaskAssessmentRun)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartReplicationTaskAssessmentRunResponse Source #

Create a value of StartReplicationTaskAssessmentRunResponse 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:replicationTaskAssessmentRun:StartReplicationTaskAssessmentRunResponse', startReplicationTaskAssessmentRunResponse_replicationTaskAssessmentRun - The premigration assessment run that was started.

$sel:httpStatus:StartReplicationTaskAssessmentRunResponse', startReplicationTaskAssessmentRunResponse_httpStatus - The response's http status code.

Response Lenses