Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DMS.DescribeApplicableIndividualAssessments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of individual assessments that you can specify for a new premigration assessment run, given one or more parameters.

If you specify an existing migration task, this operation provides the default individual assessments you can specify for that task. Otherwise, the specified parameters model elements of a possible migration task on which to base a premigration assessment run.

To use these migration task modeling parameters, you must specify an existing replication instance, a source database engine, a target database engine, and a migration type. This combination of parameters potentially limits the default individual assessments available for an assessment run created for a corresponding migration task.

If you specify no parameters, this operation provides a list of all possible individual assessments that you can specify for an assessment run. If you specify any one of the task modeling parameters, you must specify all of them or the operation cannot provide a list of individual assessments. The only parameter that you can specify alone is for an existing migration task. The specified task definition then determines the default list of individual assessments that you can specify in an assessment run for the task.

Synopsis

Creating a Request

data DescribeApplicableIndividualAssessments Source #

See: newDescribeApplicableIndividualAssessments smart constructor.

Constructors

DescribeApplicableIndividualAssessments'

Fields

migrationType :: Maybe MigrationTypeValue
Name of the migration type that each provided individual assessment must support.
sourceEngineName :: Maybe Text
Name of a database engine that the specified replication instance supports as a source.
replicationTaskArn :: Maybe Text
Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.
marker :: Maybe Text
Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
Maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.
targetEngineName :: Maybe Text
Name of a database engine that the specified replication instance supports as a target.
replicationInstanceArn :: Maybe Text
ARN of a replication instance on which you want to base the default list of individual assessments.

Instances

Instances details

Eq DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods (==) :: DescribeApplicableIndividualAssessments -> DescribeApplicableIndividualAssessments -> Bool # (/=) :: DescribeApplicableIndividualAssessments -> DescribeApplicableIndividualAssessments -> Bool #
Read DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods readsPrec :: Int -> ReadS DescribeApplicableIndividualAssessments # readList :: ReadS [DescribeApplicableIndividualAssessments] # readPrec :: ReadPrec DescribeApplicableIndividualAssessments # readListPrec :: ReadPrec [DescribeApplicableIndividualAssessments] #
Show DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods showsPrec :: Int -> DescribeApplicableIndividualAssessments -> ShowS # show :: DescribeApplicableIndividualAssessments -> String # showList :: [DescribeApplicableIndividualAssessments] -> ShowS #
Generic DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Associated Types type Rep DescribeApplicableIndividualAssessments :: Type -> Type # Methods from :: DescribeApplicableIndividualAssessments -> Rep DescribeApplicableIndividualAssessments x # to :: Rep DescribeApplicableIndividualAssessments x -> DescribeApplicableIndividualAssessments #
NFData DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods rnf :: DescribeApplicableIndividualAssessments -> () #
Hashable DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods hashWithSalt :: Int -> DescribeApplicableIndividualAssessments -> Int # hash :: DescribeApplicableIndividualAssessments -> Int #
ToJSON DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods toJSON :: DescribeApplicableIndividualAssessments -> Value # toEncoding :: DescribeApplicableIndividualAssessments -> Encoding # toJSONList :: [DescribeApplicableIndividualAssessments] -> Value # toEncodingList :: [DescribeApplicableIndividualAssessments] -> Encoding #
AWSRequest DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Associated Types type AWSResponse DescribeApplicableIndividualAssessments # Methods request :: DescribeApplicableIndividualAssessments -> Request DescribeApplicableIndividualAssessments # response :: MonadResource m => Logger -> Service -> Proxy DescribeApplicableIndividualAssessments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeApplicableIndividualAssessments))) #
ToHeaders DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods toHeaders :: DescribeApplicableIndividualAssessments -> [Header] #
ToPath DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods toPath :: DescribeApplicableIndividualAssessments -> ByteString #
ToQuery DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods toQuery :: DescribeApplicableIndividualAssessments -> QueryString #
type Rep DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments type Rep DescribeApplicableIndividualAssessments = D1 ('MetaData "DescribeApplicableIndividualAssessments" "Amazonka.DMS.DescribeApplicableIndividualAssessments" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeApplicableIndividualAssessments'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "migrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MigrationTypeValue)) :: (S1 ('MetaSel ('Just "sourceEngineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationTaskArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "targetEngineName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "replicationInstanceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse DescribeApplicableIndividualAssessments Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments type AWSResponse DescribeApplicableIndividualAssessments = DescribeApplicableIndividualAssessmentsResponse

newDescribeApplicableIndividualAssessments :: DescribeApplicableIndividualAssessments Source #

Create a value of DescribeApplicableIndividualAssessments 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:migrationType:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_migrationType - Name of the migration type that each provided individual assessment must support.

$sel:sourceEngineName:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_sourceEngineName - Name of a database engine that the specified replication instance supports as a source.

$sel:replicationTaskArn:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_replicationTaskArn - Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.

$sel:marker:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_marker - Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_maxRecords - Maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

$sel:targetEngineName:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_targetEngineName - Name of a database engine that the specified replication instance supports as a target.

$sel:replicationInstanceArn:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessments_replicationInstanceArn - ARN of a replication instance on which you want to base the default list of individual assessments.

Request Lenses

describeApplicableIndividualAssessments_migrationType :: Lens' DescribeApplicableIndividualAssessments (Maybe MigrationTypeValue) Source #

Name of the migration type that each provided individual assessment must support.

describeApplicableIndividualAssessments_sourceEngineName :: Lens' DescribeApplicableIndividualAssessments (Maybe Text) Source #

Name of a database engine that the specified replication instance supports as a source.

describeApplicableIndividualAssessments_replicationTaskArn :: Lens' DescribeApplicableIndividualAssessments (Maybe Text) Source #

Amazon Resource Name (ARN) of a migration task on which you want to base the default list of individual assessments.

describeApplicableIndividualAssessments_marker :: Lens' DescribeApplicableIndividualAssessments (Maybe Text) Source #

Optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeApplicableIndividualAssessments_maxRecords :: Lens' DescribeApplicableIndividualAssessments (Maybe Int) Source #

Maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

describeApplicableIndividualAssessments_targetEngineName :: Lens' DescribeApplicableIndividualAssessments (Maybe Text) Source #

Name of a database engine that the specified replication instance supports as a target.

describeApplicableIndividualAssessments_replicationInstanceArn :: Lens' DescribeApplicableIndividualAssessments (Maybe Text) Source #

ARN of a replication instance on which you want to base the default list of individual assessments.

Destructuring the Response

data DescribeApplicableIndividualAssessmentsResponse Source #

See: newDescribeApplicableIndividualAssessmentsResponse smart constructor.

Constructors

DescribeApplicableIndividualAssessmentsResponse'

Fields

marker :: Maybe Text
Pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.
individualAssessmentNames :: Maybe [Text]
List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeApplicableIndividualAssessmentsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods (==) :: DescribeApplicableIndividualAssessmentsResponse -> DescribeApplicableIndividualAssessmentsResponse -> Bool # (/=) :: DescribeApplicableIndividualAssessmentsResponse -> DescribeApplicableIndividualAssessmentsResponse -> Bool #
Read DescribeApplicableIndividualAssessmentsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods readsPrec :: Int -> ReadS DescribeApplicableIndividualAssessmentsResponse # readList :: ReadS [DescribeApplicableIndividualAssessmentsResponse] # readPrec :: ReadPrec DescribeApplicableIndividualAssessmentsResponse # readListPrec :: ReadPrec [DescribeApplicableIndividualAssessmentsResponse] #
Show DescribeApplicableIndividualAssessmentsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods showsPrec :: Int -> DescribeApplicableIndividualAssessmentsResponse -> ShowS # show :: DescribeApplicableIndividualAssessmentsResponse -> String # showList :: [DescribeApplicableIndividualAssessmentsResponse] -> ShowS #
Generic DescribeApplicableIndividualAssessmentsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Associated Types type Rep DescribeApplicableIndividualAssessmentsResponse :: Type -> Type # Methods from :: DescribeApplicableIndividualAssessmentsResponse -> Rep DescribeApplicableIndividualAssessmentsResponse x # to :: Rep DescribeApplicableIndividualAssessmentsResponse x -> DescribeApplicableIndividualAssessmentsResponse #
NFData DescribeApplicableIndividualAssessmentsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments Methods rnf :: DescribeApplicableIndividualAssessmentsResponse -> () #
type Rep DescribeApplicableIndividualAssessmentsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeApplicableIndividualAssessments type Rep DescribeApplicableIndividualAssessmentsResponse = D1 ('MetaData "DescribeApplicableIndividualAssessmentsResponse" "Amazonka.DMS.DescribeApplicableIndividualAssessments" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeApplicableIndividualAssessmentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "individualAssessmentNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeApplicableIndividualAssessmentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeApplicableIndividualAssessmentsResponse'`
-> DescribeApplicableIndividualAssessmentsResponse

Create a value of DescribeApplicableIndividualAssessmentsResponse 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:marker:DescribeApplicableIndividualAssessments', describeApplicableIndividualAssessmentsResponse_marker - Pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.

$sel:individualAssessmentNames:DescribeApplicableIndividualAssessmentsResponse', describeApplicableIndividualAssessmentsResponse_individualAssessmentNames - List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.

$sel:httpStatus:DescribeApplicableIndividualAssessmentsResponse', describeApplicableIndividualAssessmentsResponse_httpStatus - The response's http status code.

Response Lenses

describeApplicableIndividualAssessmentsResponse_marker :: Lens' DescribeApplicableIndividualAssessmentsResponse (Maybe Text) Source #

Pagination token returned for you to pass to a subsequent request. If you pass this token as the Marker value in a subsequent request, the response includes only records beyond the marker, up to the value specified in the request by MaxRecords.

describeApplicableIndividualAssessmentsResponse_individualAssessmentNames :: Lens' DescribeApplicableIndividualAssessmentsResponse (Maybe [Text]) Source #

List of names for the individual assessments supported by the premigration assessment run that you start based on the specified request parameters. For more information on the available individual assessments, including compatibility with different migration task configurations, see Working with premigration assessment runs in the Database Migration Service User Guide.

describeApplicableIndividualAssessmentsResponse_httpStatus :: Lens' DescribeApplicableIndividualAssessmentsResponse Int Source #

The response's http status code.