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.CloudWatchLogs.DescribeExportTasks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

This operation returns paginated results.

Synopsis

data DescribeExportTasks = DescribeExportTasks' {
- taskId :: Maybe Text
- nextToken :: Maybe Text
- limit :: Maybe Natural
- statusCode :: Maybe ExportTaskStatusCode
}
newDescribeExportTasks :: DescribeExportTasks
describeExportTasks_taskId :: Lens' DescribeExportTasks (Maybe Text)
describeExportTasks_nextToken :: Lens' DescribeExportTasks (Maybe Text)
describeExportTasks_limit :: Lens' DescribeExportTasks (Maybe Natural)
describeExportTasks_statusCode :: Lens' DescribeExportTasks (Maybe ExportTaskStatusCode)
data DescribeExportTasksResponse = DescribeExportTasksResponse' {
- nextToken :: Maybe Text
- exportTasks :: Maybe [ExportTask]
- httpStatus :: Int
}
newDescribeExportTasksResponse :: Int -> DescribeExportTasksResponse
describeExportTasksResponse_nextToken :: Lens' DescribeExportTasksResponse (Maybe Text)
describeExportTasksResponse_exportTasks :: Lens' DescribeExportTasksResponse (Maybe [ExportTask])
describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int

Creating a Request

data DescribeExportTasks Source #

See: newDescribeExportTasks smart constructor.

Constructors

DescribeExportTasks'

Fields

taskId :: Maybe Text
The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
limit :: Maybe Natural
The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
statusCode :: Maybe ExportTaskStatusCode
The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Instances

Instances details

Eq DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods (==) :: DescribeExportTasks -> DescribeExportTasks -> Bool # (/=) :: DescribeExportTasks -> DescribeExportTasks -> Bool #
Read DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods readsPrec :: Int -> ReadS DescribeExportTasks # readList :: ReadS [DescribeExportTasks] # readPrec :: ReadPrec DescribeExportTasks # readListPrec :: ReadPrec [DescribeExportTasks] #
Show DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods showsPrec :: Int -> DescribeExportTasks -> ShowS # show :: DescribeExportTasks -> String # showList :: [DescribeExportTasks] -> ShowS #
Generic DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Associated Types type Rep DescribeExportTasks :: Type -> Type # Methods from :: DescribeExportTasks -> Rep DescribeExportTasks x # to :: Rep DescribeExportTasks x -> DescribeExportTasks #
NFData DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods rnf :: DescribeExportTasks -> () #
Hashable DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods hashWithSalt :: Int -> DescribeExportTasks -> Int # hash :: DescribeExportTasks -> Int #
ToJSON DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods toJSON :: DescribeExportTasks -> Value # toEncoding :: DescribeExportTasks -> Encoding # toJSONList :: [DescribeExportTasks] -> Value # toEncodingList :: [DescribeExportTasks] -> Encoding #
AWSPager DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods page :: DescribeExportTasks -> AWSResponse DescribeExportTasks -> Maybe DescribeExportTasks #
AWSRequest DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Associated Types type AWSResponse DescribeExportTasks # Methods request :: DescribeExportTasks -> Request DescribeExportTasks # response :: MonadResource m => Logger -> Service -> Proxy DescribeExportTasks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeExportTasks))) #
ToHeaders DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods toHeaders :: DescribeExportTasks -> [Header] #
ToPath DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods toPath :: DescribeExportTasks -> ByteString #
ToQuery DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods toQuery :: DescribeExportTasks -> QueryString #
type Rep DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks type Rep DescribeExportTasks = D1 ('MetaData "DescribeExportTasks" "Amazonka.CloudWatchLogs.DescribeExportTasks" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeExportTasks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "taskId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExportTaskStatusCode)))))
type AWSResponse DescribeExportTasks Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks type AWSResponse DescribeExportTasks = DescribeExportTasksResponse

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:taskId:DescribeExportTasks', describeExportTasks_taskId - The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

$sel:nextToken:DescribeExportTasks', describeExportTasks_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:limit:DescribeExportTasks', describeExportTasks_limit - The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

$sel:statusCode:DescribeExportTasks', describeExportTasks_statusCode - The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Request Lenses

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

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

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

The token for the next set of items to return. (You received this token from a previous call.)

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

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

describeExportTasks_statusCode :: Lens' DescribeExportTasks (Maybe ExportTaskStatusCode) Source #

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

Destructuring the Response

data DescribeExportTasksResponse Source #

See: newDescribeExportTasksResponse smart constructor.

Constructors

DescribeExportTasksResponse'
Fields nextToken :: Maybe Text exportTasks :: Maybe [ExportTask] The export tasks. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods (==) :: DescribeExportTasksResponse -> DescribeExportTasksResponse -> Bool # (/=) :: DescribeExportTasksResponse -> DescribeExportTasksResponse -> Bool #
Read DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods readsPrec :: Int -> ReadS DescribeExportTasksResponse # readList :: ReadS [DescribeExportTasksResponse] # readPrec :: ReadPrec DescribeExportTasksResponse # readListPrec :: ReadPrec [DescribeExportTasksResponse] #
Show DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods showsPrec :: Int -> DescribeExportTasksResponse -> ShowS # show :: DescribeExportTasksResponse -> String # showList :: [DescribeExportTasksResponse] -> ShowS #
Generic DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Associated Types type Rep DescribeExportTasksResponse :: Type -> Type # Methods from :: DescribeExportTasksResponse -> Rep DescribeExportTasksResponse x # to :: Rep DescribeExportTasksResponse x -> DescribeExportTasksResponse #
NFData DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks Methods rnf :: DescribeExportTasksResponse -> () #
type Rep DescribeExportTasksResponse Source #
Instance details Defined in Amazonka.CloudWatchLogs.DescribeExportTasks type Rep DescribeExportTasksResponse = D1 ('MetaData "DescribeExportTasksResponse" "Amazonka.CloudWatchLogs.DescribeExportTasks" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "DescribeExportTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "exportTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExportTask])) :: 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:nextToken:DescribeExportTasks', describeExportTasksResponse_nextToken - Undocumented member.

$sel:exportTasks:DescribeExportTasksResponse', describeExportTasksResponse_exportTasks - The export tasks.

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

Response Lenses

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

Undocumented member.

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

The export tasks.

describeExportTasksResponse_httpStatus :: Lens' DescribeExportTasksResponse Int Source #

The response's http status code.