Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeExportTasks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data DescribeExportTasks = DescribeExportTasks' {
- exportTaskIdentifier :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Natural
- sourceArn :: Maybe Text
- sourceType :: Maybe ExportSourceType
}
newDescribeExportTasks :: DescribeExportTasks
describeExportTasks_exportTaskIdentifier :: Lens' DescribeExportTasks (Maybe Text)
describeExportTasks_filters :: Lens' DescribeExportTasks (Maybe [Filter])
describeExportTasks_marker :: Lens' DescribeExportTasks (Maybe Text)
describeExportTasks_maxRecords :: Lens' DescribeExportTasks (Maybe Natural)
describeExportTasks_sourceArn :: Lens' DescribeExportTasks (Maybe Text)
describeExportTasks_sourceType :: Lens' DescribeExportTasks (Maybe ExportSourceType)
data DescribeExportTasksResponse = DescribeExportTasksResponse' {
- exportTasks :: Maybe [ExportTask]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
describeExportTasksResponse_exportTasks :: Lens' DescribeExportTasksResponse (Maybe [ExportTask])
describeExportTasksResponse_marker :: Lens' DescribeExportTasksResponse (Maybe Text)
describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int

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 Methods toHeaders :: DescribeExportTasks -> [Header] #
ToPath DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods toPath :: DescribeExportTasks -> ByteString #
ToQuery DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods toQuery :: DescribeExportTasks -> QueryString #
AWSPager DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods page :: DescribeExportTasks -> AWSResponse DescribeExportTasks -> Maybe DescribeExportTasks #
AWSRequest DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Associated Types type AWSResponse DescribeExportTasks # Methods request :: (Service -> Service) -> DescribeExportTasks -> Request DescribeExportTasks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeExportTasks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExportTasks))) #
Generic DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Associated Types type Rep DescribeExportTasks :: Type -> Type # Methods from :: DescribeExportTasks -> Rep DescribeExportTasks x # to :: Rep DescribeExportTasks x -> DescribeExportTasks #
Read DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods readsPrec :: Int -> ReadS DescribeExportTasks # readList :: ReadS [DescribeExportTasks] # readPrec :: ReadPrec DescribeExportTasks # readListPrec :: ReadPrec [DescribeExportTasks] #
Show DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods showsPrec :: Int -> DescribeExportTasks -> ShowS # show :: DescribeExportTasks -> String # showList :: [DescribeExportTasks] -> ShowS #
NFData DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods rnf :: DescribeExportTasks -> () #
Eq DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods (==) :: DescribeExportTasks -> DescribeExportTasks -> Bool # (/=) :: DescribeExportTasks -> DescribeExportTasks -> Bool #
Hashable DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods hashWithSalt :: Int -> DescribeExportTasks -> Int # hash :: DescribeExportTasks -> Int #
type AWSResponse DescribeExportTasks Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks type AWSResponse DescribeExportTasks = DescribeExportTasksResponse
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.

describeExportTasks_sourceType :: Lens' DescribeExportTasks (Maybe ExportSourceType) Source #

The type of source for the export.

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 # Methods from :: DescribeExportTasksResponse -> Rep DescribeExportTasksResponse x # to :: Rep DescribeExportTasksResponse x -> DescribeExportTasksResponse #
Read DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods readsPrec :: Int -> ReadS DescribeExportTasksResponse # readList :: ReadS [DescribeExportTasksResponse] # readPrec :: ReadPrec DescribeExportTasksResponse # readListPrec :: ReadPrec [DescribeExportTasksResponse] #
Show DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods showsPrec :: Int -> DescribeExportTasksResponse -> ShowS # show :: DescribeExportTasksResponse -> String # showList :: [DescribeExportTasksResponse] -> ShowS #
NFData DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods rnf :: DescribeExportTasksResponse -> () #
Eq DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.RDS.DescribeExportTasks Methods (==) :: DescribeExportTasksResponse -> DescribeExportTasksResponse -> Bool # (/=) :: DescribeExportTasksResponse -> DescribeExportTasksResponse -> Bool #
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 #

Arguments

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

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.

describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int Source #

The response's http status code.