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.ECS.DescribeTasks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a specified task or tasks.

Currently, stopped tasks appear in the returned results for at least one hour.

Synopsis

Creating a Request

data DescribeTasks Source #

See: newDescribeTasks smart constructor.

Constructors

DescribeTasks'

Fields

cluster :: Maybe Text
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
include :: Maybe [TaskField]
Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.
tasks :: [Text]
A list of up to 100 task IDs or full ARN entries.

Instances

Instances details

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

newDescribeTasks :: DescribeTasks Source #

Create a value of DescribeTasks 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:cluster:DescribeTasks', describeTasks_cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

$sel:include:DescribeTasks', describeTasks_include - Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

DescribeTasks, describeTasks_tasks - A list of up to 100 task IDs or full ARN entries.

Request Lenses

describeTasks_cluster :: Lens' DescribeTasks (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

describeTasks_include :: Lens' DescribeTasks (Maybe [TaskField]) Source #

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

describeTasks_tasks :: Lens' DescribeTasks [Text] Source #

A list of up to 100 task IDs or full ARN entries.

Destructuring the Response

data DescribeTasksResponse Source #

See: newDescribeTasksResponse smart constructor.

Constructors

DescribeTasksResponse'
Fields failures :: Maybe [Failure] Any failures associated with the call. tasks :: Maybe [Task] The list of tasks. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeTasksResponse Source #
Instance details Defined in Amazonka.ECS.DescribeTasks Associated Types type Rep DescribeTasksResponse :: Type -> Type # Methods from :: DescribeTasksResponse -> Rep DescribeTasksResponse x # to :: Rep DescribeTasksResponse x -> DescribeTasksResponse #
Read DescribeTasksResponse Source #
Instance details Defined in Amazonka.ECS.DescribeTasks Methods readsPrec :: Int -> ReadS DescribeTasksResponse # readList :: ReadS [DescribeTasksResponse] # readPrec :: ReadPrec DescribeTasksResponse # readListPrec :: ReadPrec [DescribeTasksResponse] #
Show DescribeTasksResponse Source #
Instance details Defined in Amazonka.ECS.DescribeTasks Methods showsPrec :: Int -> DescribeTasksResponse -> ShowS # show :: DescribeTasksResponse -> String # showList :: [DescribeTasksResponse] -> ShowS #
NFData DescribeTasksResponse Source #
Instance details Defined in Amazonka.ECS.DescribeTasks Methods rnf :: DescribeTasksResponse -> () #
Eq DescribeTasksResponse Source #
Instance details Defined in Amazonka.ECS.DescribeTasks Methods (==) :: DescribeTasksResponse -> DescribeTasksResponse -> Bool # (/=) :: DescribeTasksResponse -> DescribeTasksResponse -> Bool #
type Rep DescribeTasksResponse Source #
Instance details Defined in Amazonka.ECS.DescribeTasks type Rep DescribeTasksResponse = D1 ('MetaData "DescribeTasksResponse" "Amazonka.ECS.DescribeTasks" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DescribeTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Failure])) :: (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Task])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeTasksResponse Source #

Arguments

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

Create a value of DescribeTasksResponse 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:failures:DescribeTasksResponse', describeTasksResponse_failures - Any failures associated with the call.

DescribeTasks, describeTasksResponse_tasks - The list of tasks.

$sel:httpStatus:DescribeTasksResponse', describeTasksResponse_httpStatus - The response's http status code.

Response Lenses

describeTasksResponse_failures :: Lens' DescribeTasksResponse (Maybe [Failure]) Source #

Any failures associated with the call.

describeTasksResponse_tasks :: Lens' DescribeTasksResponse (Maybe [Task]) Source #

The list of tasks.

describeTasksResponse_httpStatus :: Lens' DescribeTasksResponse Int Source #

The response's http status code.