libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs
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.CloudWatchLogs.DescribeExportTasks

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

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

Read DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Show DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Generic DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Associated Types

type Rep DescribeExportTasks :: Type -> Type #

NFData DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Methods

rnf :: DescribeExportTasks -> () #

Hashable DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

ToJSON DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

AWSPager DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

AWSRequest DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Associated Types

type AWSResponse DescribeExportTasks #

ToHeaders DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

ToPath DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

ToQuery DescribeExportTasks Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

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

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

Instances

Instances details
Eq DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Read DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Show DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Generic DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

Associated Types

type Rep DescribeExportTasksResponse :: Type -> Type #

NFData DescribeExportTasksResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.DescribeExportTasks

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 #

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