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.FSx.DescribeDataRepositoryTasks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems or caches, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, a NextToken value is returned in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

Synopsis

Creating a Request

data DescribeDataRepositoryTasks Source #

See: newDescribeDataRepositoryTasks smart constructor.

Constructors

DescribeDataRepositoryTasks'
Fields filters :: Maybe [DataRepositoryTaskFilter] (Optional) You can use filters to narrow the `DescribeDataRepositoryTasks` response to include just tasks for specific file systems, or tasks in a specific lifecycle state. maxResults :: Maybe Natural nextToken :: Maybe Text taskIds :: Maybe [Text] (Optional) IDs of the tasks whose descriptions you want to retrieve (String).

Instances

Instances details

ToJSON DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods toJSON :: DescribeDataRepositoryTasks -> Value # toEncoding :: DescribeDataRepositoryTasks -> Encoding # toJSONList :: [DescribeDataRepositoryTasks] -> Value # toEncodingList :: [DescribeDataRepositoryTasks] -> Encoding #
ToHeaders DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods toHeaders :: DescribeDataRepositoryTasks -> [Header] #
ToPath DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods toPath :: DescribeDataRepositoryTasks -> ByteString #
ToQuery DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods toQuery :: DescribeDataRepositoryTasks -> QueryString #
AWSRequest DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Associated Types type AWSResponse DescribeDataRepositoryTasks # Methods request :: (Service -> Service) -> DescribeDataRepositoryTasks -> Request DescribeDataRepositoryTasks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDataRepositoryTasks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDataRepositoryTasks))) #
Generic DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Associated Types type Rep DescribeDataRepositoryTasks :: Type -> Type # Methods from :: DescribeDataRepositoryTasks -> Rep DescribeDataRepositoryTasks x # to :: Rep DescribeDataRepositoryTasks x -> DescribeDataRepositoryTasks #
Read DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods readsPrec :: Int -> ReadS DescribeDataRepositoryTasks # readList :: ReadS [DescribeDataRepositoryTasks] # readPrec :: ReadPrec DescribeDataRepositoryTasks # readListPrec :: ReadPrec [DescribeDataRepositoryTasks] #
Show DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods showsPrec :: Int -> DescribeDataRepositoryTasks -> ShowS # show :: DescribeDataRepositoryTasks -> String # showList :: [DescribeDataRepositoryTasks] -> ShowS #
NFData DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods rnf :: DescribeDataRepositoryTasks -> () #
Eq DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods (==) :: DescribeDataRepositoryTasks -> DescribeDataRepositoryTasks -> Bool # (/=) :: DescribeDataRepositoryTasks -> DescribeDataRepositoryTasks -> Bool #
Hashable DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods hashWithSalt :: Int -> DescribeDataRepositoryTasks -> Int # hash :: DescribeDataRepositoryTasks -> Int #
type AWSResponse DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks type AWSResponse DescribeDataRepositoryTasks = DescribeDataRepositoryTasksResponse
type Rep DescribeDataRepositoryTasks Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks type Rep DescribeDataRepositoryTasks = D1 ('MetaData "DescribeDataRepositoryTasks" "Amazonka.FSx.DescribeDataRepositoryTasks" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeDataRepositoryTasks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataRepositoryTaskFilter])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "taskIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newDescribeDataRepositoryTasks :: DescribeDataRepositoryTasks Source #

Create a value of DescribeDataRepositoryTasks 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:DescribeDataRepositoryTasks', describeDataRepositoryTasks_filters - (Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.

$sel:maxResults:DescribeDataRepositoryTasks', describeDataRepositoryTasks_maxResults - Undocumented member.

DescribeDataRepositoryTasks, describeDataRepositoryTasks_nextToken - Undocumented member.

$sel:taskIds:DescribeDataRepositoryTasks', describeDataRepositoryTasks_taskIds - (Optional) IDs of the tasks whose descriptions you want to retrieve (String).

Request Lenses

describeDataRepositoryTasks_filters :: Lens' DescribeDataRepositoryTasks (Maybe [DataRepositoryTaskFilter]) Source #

(Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just tasks for specific file systems, or tasks in a specific lifecycle state.

describeDataRepositoryTasks_maxResults :: Lens' DescribeDataRepositoryTasks (Maybe Natural) Source #

Undocumented member.

describeDataRepositoryTasks_nextToken :: Lens' DescribeDataRepositoryTasks (Maybe Text) Source #

Undocumented member.

describeDataRepositoryTasks_taskIds :: Lens' DescribeDataRepositoryTasks (Maybe [Text]) Source #

(Optional) IDs of the tasks whose descriptions you want to retrieve (String).

Destructuring the Response

data DescribeDataRepositoryTasksResponse Source #

See: newDescribeDataRepositoryTasksResponse smart constructor.

Constructors

DescribeDataRepositoryTasksResponse'
Fields dataRepositoryTasks :: Maybe [DataRepositoryTask] The collection of data repository task descriptions returned. nextToken :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeDataRepositoryTasksResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Associated Types type Rep DescribeDataRepositoryTasksResponse :: Type -> Type # Methods from :: DescribeDataRepositoryTasksResponse -> Rep DescribeDataRepositoryTasksResponse x # to :: Rep DescribeDataRepositoryTasksResponse x -> DescribeDataRepositoryTasksResponse #
Read DescribeDataRepositoryTasksResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods readsPrec :: Int -> ReadS DescribeDataRepositoryTasksResponse # readList :: ReadS [DescribeDataRepositoryTasksResponse] # readPrec :: ReadPrec DescribeDataRepositoryTasksResponse # readListPrec :: ReadPrec [DescribeDataRepositoryTasksResponse] #
Show DescribeDataRepositoryTasksResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods showsPrec :: Int -> DescribeDataRepositoryTasksResponse -> ShowS # show :: DescribeDataRepositoryTasksResponse -> String # showList :: [DescribeDataRepositoryTasksResponse] -> ShowS #
NFData DescribeDataRepositoryTasksResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods rnf :: DescribeDataRepositoryTasksResponse -> () #
Eq DescribeDataRepositoryTasksResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks Methods (==) :: DescribeDataRepositoryTasksResponse -> DescribeDataRepositoryTasksResponse -> Bool # (/=) :: DescribeDataRepositoryTasksResponse -> DescribeDataRepositoryTasksResponse -> Bool #
type Rep DescribeDataRepositoryTasksResponse Source #
Instance details Defined in Amazonka.FSx.DescribeDataRepositoryTasks type Rep DescribeDataRepositoryTasksResponse = D1 ('MetaData "DescribeDataRepositoryTasksResponse" "Amazonka.FSx.DescribeDataRepositoryTasks" "amazonka-fsx-2.0-6W1DYEEbHPkD4DJvTvpQG4" 'False) (C1 ('MetaCons "DescribeDataRepositoryTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataRepositoryTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataRepositoryTask])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDataRepositoryTasksResponse Source #

Arguments

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

Create a value of DescribeDataRepositoryTasksResponse 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:dataRepositoryTasks:DescribeDataRepositoryTasksResponse', describeDataRepositoryTasksResponse_dataRepositoryTasks - The collection of data repository task descriptions returned.

DescribeDataRepositoryTasks, describeDataRepositoryTasksResponse_nextToken - Undocumented member.

$sel:httpStatus:DescribeDataRepositoryTasksResponse', describeDataRepositoryTasksResponse_httpStatus - The response's http status code.

Response Lenses

describeDataRepositoryTasksResponse_dataRepositoryTasks :: Lens' DescribeDataRepositoryTasksResponse (Maybe [DataRepositoryTask]) Source #

The collection of data repository task descriptions returned.

describeDataRepositoryTasksResponse_nextToken :: Lens' DescribeDataRepositoryTasksResponse (Maybe Text) Source #

Undocumented member.

describeDataRepositoryTasksResponse_httpStatus :: Lens' DescribeDataRepositoryTasksResponse Int Source #

The response's http status code.