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.SSM.DescribeMaintenanceWindowTasks

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the tasks in a maintenance window.

For maintenance window tasks without a specified target, you can't supply values for --max-errors and --max-concurrency. Instead, the system inserts a placeholder value of 1, which may be reported in the response to this command. These values don't affect the running of your task and can be ignored.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeMaintenanceWindowTasks Source #

See: newDescribeMaintenanceWindowTasks smart constructor.

Constructors

DescribeMaintenanceWindowTasks'

Fields

filters :: Maybe [MaintenanceWindowFilter]
Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.
maxResults :: Maybe Natural
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
nextToken :: Maybe Text
The token for the next set of items to return. (You received this token from a previous call.)
windowId :: Text
The ID of the maintenance window whose tasks should be retrieved.

Instances

Instances details

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

newDescribeMaintenanceWindowTasks Source #

Arguments

:: Text	`DescribeMaintenanceWindowTasks`
-> DescribeMaintenanceWindowTasks

Create a value of DescribeMaintenanceWindowTasks 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:

DescribeMaintenanceWindowTasks, describeMaintenanceWindowTasks_filters - Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

$sel:maxResults:DescribeMaintenanceWindowTasks', describeMaintenanceWindowTasks_maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

DescribeMaintenanceWindowTasks, describeMaintenanceWindowTasks_windowId - The ID of the maintenance window whose tasks should be retrieved.

Request Lenses

describeMaintenanceWindowTasks_filters :: Lens' DescribeMaintenanceWindowTasks (Maybe [MaintenanceWindowFilter]) Source #

Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

describeMaintenanceWindowTasks_maxResults :: Lens' DescribeMaintenanceWindowTasks (Maybe Natural) Source #

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

describeMaintenanceWindowTasks_nextToken :: Lens' DescribeMaintenanceWindowTasks (Maybe Text) Source #

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

describeMaintenanceWindowTasks_windowId :: Lens' DescribeMaintenanceWindowTasks Text Source #

The ID of the maintenance window whose tasks should be retrieved.

Destructuring the Response

data DescribeMaintenanceWindowTasksResponse Source #

See: newDescribeMaintenanceWindowTasksResponse smart constructor.

Constructors

DescribeMaintenanceWindowTasksResponse'
Fields nextToken :: Maybe Text The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. tasks :: Maybe [MaintenanceWindowTask] Information about the tasks in the maintenance window. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeMaintenanceWindowTasksResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowTasks Associated Types type Rep DescribeMaintenanceWindowTasksResponse :: Type -> Type # Methods from :: DescribeMaintenanceWindowTasksResponse -> Rep DescribeMaintenanceWindowTasksResponse x # to :: Rep DescribeMaintenanceWindowTasksResponse x -> DescribeMaintenanceWindowTasksResponse #
Show DescribeMaintenanceWindowTasksResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowTasks Methods showsPrec :: Int -> DescribeMaintenanceWindowTasksResponse -> ShowS # show :: DescribeMaintenanceWindowTasksResponse -> String # showList :: [DescribeMaintenanceWindowTasksResponse] -> ShowS #
NFData DescribeMaintenanceWindowTasksResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowTasks Methods rnf :: DescribeMaintenanceWindowTasksResponse -> () #
Eq DescribeMaintenanceWindowTasksResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowTasks Methods (==) :: DescribeMaintenanceWindowTasksResponse -> DescribeMaintenanceWindowTasksResponse -> Bool # (/=) :: DescribeMaintenanceWindowTasksResponse -> DescribeMaintenanceWindowTasksResponse -> Bool #
type Rep DescribeMaintenanceWindowTasksResponse Source #
Instance details Defined in Amazonka.SSM.DescribeMaintenanceWindowTasks type Rep DescribeMaintenanceWindowTasksResponse = D1 ('MetaData "DescribeMaintenanceWindowTasksResponse" "Amazonka.SSM.DescribeMaintenanceWindowTasks" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "DescribeMaintenanceWindowTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MaintenanceWindowTask])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeMaintenanceWindowTasksResponse Source #

Arguments

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

Create a value of DescribeMaintenanceWindowTasksResponse 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:

DescribeMaintenanceWindowTasks, describeMaintenanceWindowTasksResponse_nextToken - The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

$sel:tasks:DescribeMaintenanceWindowTasksResponse', describeMaintenanceWindowTasksResponse_tasks - Information about the tasks in the maintenance window.

$sel:httpStatus:DescribeMaintenanceWindowTasksResponse', describeMaintenanceWindowTasksResponse_httpStatus - The response's http status code.

Response Lenses

describeMaintenanceWindowTasksResponse_nextToken :: Lens' DescribeMaintenanceWindowTasksResponse (Maybe Text) Source #

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

describeMaintenanceWindowTasksResponse_tasks :: Lens' DescribeMaintenanceWindowTasksResponse (Maybe [MaintenanceWindowTask]) Source #

Information about the tasks in the maintenance window.

describeMaintenanceWindowTasksResponse_httpStatus :: Lens' DescribeMaintenanceWindowTasksResponse Int Source #

The response's http status code.