| 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.Discovery.DescribeExportTasks
Description
Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.
This operation returns paginated results.
Synopsis
- data DescribeExportTasks = DescribeExportTasks' {}
- newDescribeExportTasks :: DescribeExportTasks
- describeExportTasks_filters :: Lens' DescribeExportTasks (Maybe [ExportFilter])
- describeExportTasks_nextToken :: Lens' DescribeExportTasks (Maybe Text)
- describeExportTasks_exportIds :: Lens' DescribeExportTasks (Maybe [Text])
- describeExportTasks_maxResults :: Lens' DescribeExportTasks (Maybe Int)
- data DescribeExportTasksResponse = DescribeExportTasksResponse' {
- nextToken :: Maybe Text
- exportsInfo :: Maybe [ExportInfo]
- httpStatus :: Int
- newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
- describeExportTasksResponse_nextToken :: Lens' DescribeExportTasksResponse (Maybe Text)
- describeExportTasksResponse_exportsInfo :: Lens' DescribeExportTasksResponse (Maybe [ExportInfo])
- describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int
Creating a Request
data DescribeExportTasks Source #
See: newDescribeExportTasks smart constructor.
Constructors
| DescribeExportTasks' | |
Fields
| |
Instances
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:
$sel:filters:DescribeExportTasks', describeExportTasks_filters - One or more filters.
AgentId- ID of the agent whose collected data will be exported
$sel:nextToken:DescribeExportTasks', describeExportTasks_nextToken - The nextToken value returned from a previous paginated
DescribeExportTasks request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
This value is null when there are no more results to return.
$sel:exportIds:DescribeExportTasks', describeExportTasks_exportIds - One or more unique identifiers used to query the status of an export
request.
$sel:maxResults:DescribeExportTasks', describeExportTasks_maxResults - The maximum number of volume results returned by DescribeExportTasks
in paginated output. When this parameter is used, DescribeExportTasks
only returns maxResults results in a single page along with a
nextToken response element.
Request Lenses
describeExportTasks_filters :: Lens' DescribeExportTasks (Maybe [ExportFilter]) Source #
One or more filters.
AgentId- ID of the agent whose collected data will be exported
describeExportTasks_nextToken :: Lens' DescribeExportTasks (Maybe Text) Source #
The nextToken value returned from a previous paginated
DescribeExportTasks request where maxResults was used and the
results exceeded the value of that parameter. Pagination continues from
the end of the previous results that returned the nextToken value.
This value is null when there are no more results to return.
describeExportTasks_exportIds :: Lens' DescribeExportTasks (Maybe [Text]) Source #
One or more unique identifiers used to query the status of an export request.
describeExportTasks_maxResults :: Lens' DescribeExportTasks (Maybe Int) Source #
The maximum number of volume results returned by DescribeExportTasks
in paginated output. When this parameter is used, DescribeExportTasks
only returns maxResults results in a single page along with a
nextToken response element.
Destructuring the Response
data DescribeExportTasksResponse Source #
See: newDescribeExportTasksResponse smart constructor.
Constructors
| DescribeExportTasksResponse' | |
Fields
| |
Instances
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:nextToken:DescribeExportTasks', describeExportTasksResponse_nextToken - The nextToken value to include in a future DescribeExportTasks
request. When the results of a DescribeExportTasks request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
$sel:exportsInfo:DescribeExportTasksResponse', describeExportTasksResponse_exportsInfo - Contains one or more sets of export request details. When the status of
a request is SUCCEEDED, the response includes a URL for an Amazon S3
bucket where you can view the data in a CSV file.
$sel:httpStatus:DescribeExportTasksResponse', describeExportTasksResponse_httpStatus - The response's http status code.
Response Lenses
describeExportTasksResponse_nextToken :: Lens' DescribeExportTasksResponse (Maybe Text) Source #
The nextToken value to include in a future DescribeExportTasks
request. When the results of a DescribeExportTasks request exceed
maxResults, this value can be used to retrieve the next page of
results. This value is null when there are no more results to return.
describeExportTasksResponse_exportsInfo :: Lens' DescribeExportTasksResponse (Maybe [ExportInfo]) Source #
Contains one or more sets of export request details. When the status of
a request is SUCCEEDED, the response includes a URL for an Amazon S3
bucket where you can view the data in a CSV file.
describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int Source #
The response's http status code.