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.DescribeMaintenanceWindowSchedule

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about upcoming executions of a maintenance window.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeMaintenanceWindowSchedule Source #

See: newDescribeMaintenanceWindowSchedule smart constructor.

Constructors

DescribeMaintenanceWindowSchedule'

Fields

filters :: Maybe [PatchOrchestratorFilter]
Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.
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.)
resourceType :: Maybe MaintenanceWindowResourceType
The type of resource you want to retrieve information about. For example, INSTANCE.
targets :: Maybe [Target]
The managed node ID or key-value pair to retrieve information about.
windowId :: Maybe Text
The ID of the maintenance window to retrieve information about.

Instances

Instances details

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

newDescribeMaintenanceWindowSchedule :: DescribeMaintenanceWindowSchedule Source #

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

DescribeMaintenanceWindowSchedule, describeMaintenanceWindowSchedule_filters - Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

$sel:maxResults:DescribeMaintenanceWindowSchedule', describeMaintenanceWindowSchedule_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.

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

DescribeMaintenanceWindowSchedule, describeMaintenanceWindowSchedule_resourceType - The type of resource you want to retrieve information about. For example, INSTANCE.

DescribeMaintenanceWindowSchedule, describeMaintenanceWindowSchedule_targets - The managed node ID or key-value pair to retrieve information about.

DescribeMaintenanceWindowSchedule, describeMaintenanceWindowSchedule_windowId - The ID of the maintenance window to retrieve information about.

Request Lenses

describeMaintenanceWindowSchedule_filters :: Lens' DescribeMaintenanceWindowSchedule (Maybe [PatchOrchestratorFilter]) Source #

Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

describeMaintenanceWindowSchedule_maxResults :: Lens' DescribeMaintenanceWindowSchedule (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.

describeMaintenanceWindowSchedule_nextToken :: Lens' DescribeMaintenanceWindowSchedule (Maybe Text) Source #

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

describeMaintenanceWindowSchedule_resourceType :: Lens' DescribeMaintenanceWindowSchedule (Maybe MaintenanceWindowResourceType) Source #

The type of resource you want to retrieve information about. For example, INSTANCE.

describeMaintenanceWindowSchedule_targets :: Lens' DescribeMaintenanceWindowSchedule (Maybe [Target]) Source #

The managed node ID or key-value pair to retrieve information about.

describeMaintenanceWindowSchedule_windowId :: Lens' DescribeMaintenanceWindowSchedule (Maybe Text) Source #

The ID of the maintenance window to retrieve information about.

Destructuring the Response

data DescribeMaintenanceWindowScheduleResponse Source #

See: newDescribeMaintenanceWindowScheduleResponse smart constructor.

Constructors

DescribeMaintenanceWindowScheduleResponse'
Fields nextToken :: Maybe Text The token for the next set of items to return. (You use this token in the next call.) scheduledWindowExecutions :: Maybe [ScheduledWindowExecution] Information about maintenance window executions scheduled for the specified time range. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeMaintenanceWindowScheduleResponse Source #

Arguments

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

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

DescribeMaintenanceWindowSchedule, describeMaintenanceWindowScheduleResponse_nextToken - The token for the next set of items to return. (You use this token in the next call.)

$sel:scheduledWindowExecutions:DescribeMaintenanceWindowScheduleResponse', describeMaintenanceWindowScheduleResponse_scheduledWindowExecutions - Information about maintenance window executions scheduled for the specified time range.

$sel:httpStatus:DescribeMaintenanceWindowScheduleResponse', describeMaintenanceWindowScheduleResponse_httpStatus - The response's http status code.

Response Lenses

describeMaintenanceWindowScheduleResponse_nextToken :: Lens' DescribeMaintenanceWindowScheduleResponse (Maybe Text) Source #

The token for the next set of items to return. (You use this token in the next call.)

describeMaintenanceWindowScheduleResponse_scheduledWindowExecutions :: Lens' DescribeMaintenanceWindowScheduleResponse (Maybe [ScheduledWindowExecution]) Source #

Information about maintenance window executions scheduled for the specified time range.

describeMaintenanceWindowScheduleResponse_httpStatus :: Lens' DescribeMaintenanceWindowScheduleResponse Int Source #

The response's http status code.