libZSservicesZSamazonka-ssmZSamazonka-ssm
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.SSM.DescribeMaintenanceWindowSchedule

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

  • resourceType :: Maybe MaintenanceWindowResourceType

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

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

  • nextToken :: Maybe Text

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

  • targets :: Maybe [Target]

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

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

  • windowId :: Maybe Text

    The ID of the maintenance window to retrieve information about.

Instances

Instances details
Eq DescribeMaintenanceWindowSchedule Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

Methods

(==) :: DescribeMaintenanceWindowSchedule -> DescribeMaintenanceWindowSchedule -> Bool #

(/=) :: DescribeMaintenanceWindowSchedule -> DescribeMaintenanceWindowSchedule -> Bool #

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 #

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 #

NFData DescribeMaintenanceWindowSchedule Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

Methods

rnf :: DescribeMaintenanceWindowSchedule -> () #

Hashable DescribeMaintenanceWindowSchedule Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

Methods

hashWithSalt :: Int -> DescribeMaintenanceWindowSchedule -> Int #

hash :: DescribeMaintenanceWindowSchedule -> Int #

ToJSON DescribeMaintenanceWindowSchedule Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

Methods

toJSON :: DescribeMaintenanceWindowSchedule -> Value #

toEncoding :: DescribeMaintenanceWindowSchedule -> Encoding #

toJSONList :: [DescribeMaintenanceWindowSchedule] -> Value #

toEncodingList :: [DescribeMaintenanceWindowSchedule] -> Encoding #

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 :: DescribeMaintenanceWindowSchedule -> Request DescribeMaintenanceWindowSchedule #

response :: MonadResource m => Logger -> Service -> Proxy DescribeMaintenanceWindowSchedule -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMaintenanceWindowSchedule))) #

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 #

type Rep DescribeMaintenanceWindowSchedule Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

type Rep DescribeMaintenanceWindowSchedule = D1 ('MetaData "DescribeMaintenanceWindowSchedule" "Amazonka.SSM.DescribeMaintenanceWindowSchedule" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeMaintenanceWindowSchedule'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaintenanceWindowResourceType)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOrchestratorFilter])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Target])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))
type AWSResponse DescribeMaintenanceWindowSchedule Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

type AWSResponse DescribeMaintenanceWindowSchedule = DescribeMaintenanceWindowScheduleResponse

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:

$sel:resourceType:DescribeMaintenanceWindowSchedule', describeMaintenanceWindowSchedule_resourceType - The type of resource you want to retrieve information about. For example, INSTANCE.

$sel:filters: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:nextToken:DescribeMaintenanceWindowSchedule', describeMaintenanceWindowSchedule_nextToken - The token for the next set of items to return. (You received this token from a previous call.)

$sel:targets:DescribeMaintenanceWindowSchedule', describeMaintenanceWindowSchedule_targets - The instance ID or key-value pair to retrieve information about.

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

$sel:windowId:DescribeMaintenanceWindowSchedule', describeMaintenanceWindowSchedule_windowId - The ID of the maintenance window to retrieve information about.

Request Lenses

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

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

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_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_targets :: Lens' DescribeMaintenanceWindowSchedule (Maybe [Target]) Source #

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

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_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

Instances

Instances details
Eq DescribeMaintenanceWindowScheduleResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

Methods

(==) :: DescribeMaintenanceWindowScheduleResponse -> DescribeMaintenanceWindowScheduleResponse -> Bool #

(/=) :: DescribeMaintenanceWindowScheduleResponse -> DescribeMaintenanceWindowScheduleResponse -> Bool #

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 #

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 #

NFData DescribeMaintenanceWindowScheduleResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

Methods

rnf :: DescribeMaintenanceWindowScheduleResponse -> () #

type Rep DescribeMaintenanceWindowScheduleResponse Source # 
Instance details

Defined in Amazonka.SSM.DescribeMaintenanceWindowSchedule

type Rep DescribeMaintenanceWindowScheduleResponse = D1 ('MetaData "DescribeMaintenanceWindowScheduleResponse" "Amazonka.SSM.DescribeMaintenanceWindowSchedule" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "DescribeMaintenanceWindowScheduleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduledWindowExecutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ScheduledWindowExecution])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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:

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

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

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

Response Lenses

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

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

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_httpStatus :: Lens' DescribeMaintenanceWindowScheduleResponse Int Source #

The response's http status code.