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.DescribeReplicationTaskAssessmentResults

Description

Returns the task assessment results from the Amazon S3 bucket that DMS creates in your Amazon Web Services account. This action always returns the latest results.

For more information about DMS task assessments, see Creating a task assessment report in the Database Migration Service User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReplicationTaskAssessmentResults Source #

Constructors

DescribeReplicationTaskAssessmentResults' 

Fields

  • replicationTaskArn :: Maybe Text

    The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters.

  • marker :: Maybe Text

    An 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

    The 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.

    Default: 100

    Constraints: Minimum 20, maximum 100.

Instances

Instances details
Eq DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Read DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Show DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Generic DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

NFData DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Hashable DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

ToJSON DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

AWSPager DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

AWSRequest DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

ToHeaders DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

ToPath DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

ToQuery DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

type Rep DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

type Rep DescribeReplicationTaskAssessmentResults = D1 ('MetaData "DescribeReplicationTaskAssessmentResults" "Amazonka.DMS.DescribeReplicationTaskAssessmentResults" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeReplicationTaskAssessmentResults'" 'PrefixI 'True) (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)))))
type AWSResponse DescribeReplicationTaskAssessmentResults Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

newDescribeReplicationTaskAssessmentResults :: DescribeReplicationTaskAssessmentResults Source #

Create a value of DescribeReplicationTaskAssessmentResults 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:replicationTaskArn:DescribeReplicationTaskAssessmentResults', describeReplicationTaskAssessmentResults_replicationTaskArn - The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters.

$sel:marker:DescribeReplicationTaskAssessmentResults', describeReplicationTaskAssessmentResults_marker - An 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:DescribeReplicationTaskAssessmentResults', describeReplicationTaskAssessmentResults_maxRecords - The 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.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeReplicationTaskAssessmentResults_replicationTaskArn :: Lens' DescribeReplicationTaskAssessmentResults (Maybe Text) Source #

The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified, the API returns only one result and ignore the values of the MaxRecords and Marker parameters.

describeReplicationTaskAssessmentResults_marker :: Lens' DescribeReplicationTaskAssessmentResults (Maybe Text) Source #

An 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.

describeReplicationTaskAssessmentResults_maxRecords :: Lens' DescribeReplicationTaskAssessmentResults (Maybe Int) Source #

The 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.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeReplicationTaskAssessmentResultsResponse Source #

Constructors

DescribeReplicationTaskAssessmentResultsResponse' 

Fields

Instances

Instances details
Eq DescribeReplicationTaskAssessmentResultsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Read DescribeReplicationTaskAssessmentResultsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Show DescribeReplicationTaskAssessmentResultsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

Generic DescribeReplicationTaskAssessmentResultsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

NFData DescribeReplicationTaskAssessmentResultsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

type Rep DescribeReplicationTaskAssessmentResultsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeReplicationTaskAssessmentResults

type Rep DescribeReplicationTaskAssessmentResultsResponse = D1 ('MetaData "DescribeReplicationTaskAssessmentResultsResponse" "Amazonka.DMS.DescribeReplicationTaskAssessmentResults" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeReplicationTaskAssessmentResultsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "replicationTaskAssessmentResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationTaskAssessmentResult])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReplicationTaskAssessmentResultsResponse Source #

Create a value of DescribeReplicationTaskAssessmentResultsResponse 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:bucketName:DescribeReplicationTaskAssessmentResultsResponse', describeReplicationTaskAssessmentResultsResponse_bucketName - - The Amazon S3 bucket where the task assessment report is located.

$sel:marker:DescribeReplicationTaskAssessmentResults', describeReplicationTaskAssessmentResultsResponse_marker - An 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:replicationTaskAssessmentResults:DescribeReplicationTaskAssessmentResultsResponse', describeReplicationTaskAssessmentResultsResponse_replicationTaskAssessmentResults - The task assessment report.

$sel:httpStatus:DescribeReplicationTaskAssessmentResultsResponse', describeReplicationTaskAssessmentResultsResponse_httpStatus - The response's http status code.

Response Lenses

describeReplicationTaskAssessmentResultsResponse_marker :: Lens' DescribeReplicationTaskAssessmentResultsResponse (Maybe Text) Source #

An 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.