amazonka-rds-2.0: Amazon Relational Database Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RDS.DescribeExportTasks

Description

Returns information about a snapshot export to Amazon S3. This API operation supports pagination.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeExportTasks Source #

See: newDescribeExportTasks smart constructor.

Constructors

DescribeExportTasks' 

Fields

  • exportTaskIdentifier :: Maybe Text

    The identifier of the snapshot export task to be described.

  • filters :: Maybe [Filter]

    Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

    Supported filters include the following:

    • export-task-identifier - An identifier for the snapshot export task.
    • s3-bucket - The Amazon S3 bucket the snapshot is exported to.
    • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
    • status - The status of the export task. Must be lowercase. Valid statuses are the following:

      • canceled
      • canceling
      • complete
      • failed
      • in_progress
      • starting
  • marker :: Maybe Text

    An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

  • maxRecords :: Maybe Natural

    The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

  • sourceArn :: Maybe Text

    The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

  • sourceType :: Maybe ExportSourceType

    The type of source for the export.

Instances

Instances details
ToHeaders DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

ToPath DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

ToQuery DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

AWSPager DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

AWSRequest DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Associated Types

type AWSResponse DescribeExportTasks #

Generic DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Associated Types

type Rep DescribeExportTasks :: Type -> Type #

Read DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Show DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

NFData DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Methods

rnf :: DescribeExportTasks -> () #

Eq DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Hashable DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

type AWSResponse DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

type Rep DescribeExportTasks Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

type Rep DescribeExportTasks = D1 ('MetaData "DescribeExportTasks" "Amazonka.RDS.DescribeExportTasks" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeExportTasks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "exportTaskIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "sourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportSourceType))))))

newDescribeExportTasks :: DescribeExportTasks Source #

Create a value of DescribeExportTasks 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:

DescribeExportTasks, describeExportTasks_exportTaskIdentifier - The identifier of the snapshot export task to be described.

$sel:filters:DescribeExportTasks', describeExportTasks_filters - Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.
  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.
  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
  • status - The status of the export task. Must be lowercase. Valid statuses are the following:

    • canceled
    • canceling
    • complete
    • failed
    • in_progress
    • starting

DescribeExportTasks, describeExportTasks_marker - An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

$sel:maxRecords:DescribeExportTasks', describeExportTasks_maxRecords - The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

DescribeExportTasks, describeExportTasks_sourceArn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

DescribeExportTasks, describeExportTasks_sourceType - The type of source for the export.

Request Lenses

describeExportTasks_exportTaskIdentifier :: Lens' DescribeExportTasks (Maybe Text) Source #

The identifier of the snapshot export task to be described.

describeExportTasks_filters :: Lens' DescribeExportTasks (Maybe [Filter]) Source #

Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive.

Supported filters include the following:

  • export-task-identifier - An identifier for the snapshot export task.
  • s3-bucket - The Amazon S3 bucket the snapshot is exported to.
  • source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
  • status - The status of the export task. Must be lowercase. Valid statuses are the following:

    • canceled
    • canceling
    • complete
    • failed
    • in_progress
    • starting

describeExportTasks_marker :: Lens' DescribeExportTasks (Maybe Text) Source #

An optional pagination token provided by a previous DescribeExportTasks request. If you specify this parameter, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

describeExportTasks_maxRecords :: Lens' DescribeExportTasks (Maybe Natural) Source #

The maximum number of records to include in the response. If more records exist than the specified value, a pagination token called a marker is included in the response. You can use the marker in a later DescribeExportTasks request to retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

describeExportTasks_sourceArn :: Lens' DescribeExportTasks (Maybe Text) Source #

The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.

Destructuring the Response

data DescribeExportTasksResponse Source #

See: newDescribeExportTasksResponse smart constructor.

Constructors

DescribeExportTasksResponse' 

Fields

  • exportTasks :: Maybe [ExportTask]

    Information about an export of a snapshot to Amazon S3.

  • marker :: Maybe Text

    A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Associated Types

type Rep DescribeExportTasksResponse :: Type -> Type #

Read DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Show DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

NFData DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

Eq DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

type Rep DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeExportTasks

type Rep DescribeExportTasksResponse = D1 ('MetaData "DescribeExportTasksResponse" "Amazonka.RDS.DescribeExportTasks" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeExportTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "exportTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExportTask])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeExportTasksResponse Source #

Create a value of DescribeExportTasksResponse 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:exportTasks:DescribeExportTasksResponse', describeExportTasksResponse_exportTasks - Information about an export of a snapshot to Amazon S3.

DescribeExportTasks, describeExportTasksResponse_marker - A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.

$sel:httpStatus:DescribeExportTasksResponse', describeExportTasksResponse_httpStatus - The response's http status code.

Response Lenses

describeExportTasksResponse_exportTasks :: Lens' DescribeExportTasksResponse (Maybe [ExportTask]) Source #

Information about an export of a snapshot to Amazon S3.

describeExportTasksResponse_marker :: Lens' DescribeExportTasksResponse (Maybe Text) Source #

A pagination token that can be used in a later DescribeExportTasks request. A marker is used for pagination to identify the location to begin output for the next response of DescribeExportTasks.