libZSservicesZSamazonka-datasyncZSamazonka-datasync
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.DataSync.ListTasks

Description

Returns a list of all the tasks.

This operation returns paginated results.

Synopsis

Creating a Request

data ListTasks Source #

ListTasksRequest

See: newListTasks smart constructor.

Constructors

ListTasks' 

Fields

  • filters :: Maybe [TaskFilter]

    You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

  • nextToken :: Maybe Text

    An opaque string that indicates the position at which to begin the next list of tasks.

  • maxResults :: Maybe Natural

    The maximum number of tasks to return.

Instances

Instances details
Eq ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Read ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Show ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Generic ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Associated Types

type Rep ListTasks :: Type -> Type #

NFData ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Methods

rnf :: ListTasks -> () #

Hashable ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

ToJSON ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

AWSPager ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

AWSRequest ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Associated Types

type AWSResponse ListTasks #

ToHeaders ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Methods

toHeaders :: ListTasks -> [Header] #

ToPath ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

ToQuery ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

type Rep ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

type Rep ListTasks = D1 ('MetaData "ListTasks" "Amazonka.DataSync.ListTasks" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "ListTasks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaskFilter])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListTasks Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

newListTasks :: ListTasks Source #

Create a value of ListTasks 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:ListTasks', listTasks_filters - You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

$sel:nextToken:ListTasks', listTasks_nextToken - An opaque string that indicates the position at which to begin the next list of tasks.

$sel:maxResults:ListTasks', listTasks_maxResults - The maximum number of tasks to return.

Request Lenses

listTasks_filters :: Lens' ListTasks (Maybe [TaskFilter]) Source #

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

listTasks_nextToken :: Lens' ListTasks (Maybe Text) Source #

An opaque string that indicates the position at which to begin the next list of tasks.

listTasks_maxResults :: Lens' ListTasks (Maybe Natural) Source #

The maximum number of tasks to return.

Destructuring the Response

data ListTasksResponse Source #

ListTasksResponse

See: newListTasksResponse smart constructor.

Constructors

ListTasksResponse' 

Fields

Instances

Instances details
Eq ListTasksResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Read ListTasksResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Show ListTasksResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Generic ListTasksResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Associated Types

type Rep ListTasksResponse :: Type -> Type #

NFData ListTasksResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

Methods

rnf :: ListTasksResponse -> () #

type Rep ListTasksResponse Source # 
Instance details

Defined in Amazonka.DataSync.ListTasks

type Rep ListTasksResponse = D1 ('MetaData "ListTasksResponse" "Amazonka.DataSync.ListTasks" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "ListTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TaskListEntry])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTasksResponse Source #

Create a value of ListTasksResponse 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:tasks:ListTasksResponse', listTasksResponse_tasks - A list of all the tasks that are returned.

$sel:nextToken:ListTasks', listTasksResponse_nextToken - An opaque string that indicates the position at which to begin returning the next list of tasks.

$sel:httpStatus:ListTasksResponse', listTasksResponse_httpStatus - The response's http status code.

Response Lenses

listTasksResponse_tasks :: Lens' ListTasksResponse (Maybe [TaskListEntry]) Source #

A list of all the tasks that are returned.

listTasksResponse_nextToken :: Lens' ListTasksResponse (Maybe Text) Source #

An opaque string that indicates the position at which to begin returning the next list of tasks.

listTasksResponse_httpStatus :: Lens' ListTasksResponse Int Source #

The response's http status code.