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

Description

Retrieves a maintenance window.

Synopsis

Creating a Request

data GetMaintenanceWindow Source #

See: newGetMaintenanceWindow smart constructor.

Constructors

GetMaintenanceWindow' 

Fields

  • windowId :: Text

    The ID of the maintenance window for which you want to retrieve information.

Instances

Instances details
Eq GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

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

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

Read GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

readsPrec :: Int -> ReadS GetMaintenanceWindow #

readList :: ReadS [GetMaintenanceWindow] #

readPrec :: ReadPrec GetMaintenanceWindow #

readListPrec :: ReadPrec [GetMaintenanceWindow] #

Show GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

showsPrec :: Int -> GetMaintenanceWindow -> ShowS #

show :: GetMaintenanceWindow -> String #

showList :: [GetMaintenanceWindow] -> ShowS #

Generic GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Associated Types

type Rep GetMaintenanceWindow :: Type -> Type #

Methods

from :: GetMaintenanceWindow -> Rep GetMaintenanceWindow x #

to :: Rep GetMaintenanceWindow x -> GetMaintenanceWindow #

NFData GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

rnf :: GetMaintenanceWindow -> () #

Hashable GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

hashWithSalt :: Int -> GetMaintenanceWindow -> Int #

hash :: GetMaintenanceWindow -> Int #

ToJSON GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toJSON :: GetMaintenanceWindow -> Value #

toEncoding :: GetMaintenanceWindow -> Encoding #

toJSONList :: [GetMaintenanceWindow] -> Value #

toEncodingList :: [GetMaintenanceWindow] -> Encoding #

AWSRequest GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Associated Types

type AWSResponse GetMaintenanceWindow #

Methods

request :: GetMaintenanceWindow -> Request GetMaintenanceWindow #

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

ToHeaders GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toHeaders :: GetMaintenanceWindow -> [Header] #

ToPath GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toPath :: GetMaintenanceWindow -> ByteString #

ToQuery GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toQuery :: GetMaintenanceWindow -> QueryString #

type Rep GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

type Rep GetMaintenanceWindow = D1 ('MetaData "GetMaintenanceWindow" "Amazonka.SSM.GetMaintenanceWindow" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetMaintenanceWindow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetMaintenanceWindow Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

type AWSResponse GetMaintenanceWindow = GetMaintenanceWindowResponse

newGetMaintenanceWindow Source #

Arguments

:: Text

$sel:windowId:GetMaintenanceWindow'

-> GetMaintenanceWindow 

Create a value of GetMaintenanceWindow 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:windowId:GetMaintenanceWindow', getMaintenanceWindow_windowId - The ID of the maintenance window for which you want to retrieve information.

Request Lenses

getMaintenanceWindow_windowId :: Lens' GetMaintenanceWindow Text Source #

The ID of the maintenance window for which you want to retrieve information.

Destructuring the Response

data GetMaintenanceWindowResponse Source #

See: newGetMaintenanceWindowResponse smart constructor.

Constructors

GetMaintenanceWindowResponse' 

Fields

  • enabled :: Maybe Bool

    Indicates whether the maintenance window is enabled.

  • schedule :: Maybe Text

    The schedule of the maintenance window in the form of a cron or rate expression.

  • nextExecutionTime :: Maybe Text

    The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

  • scheduleOffset :: Maybe Natural

    The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

  • endDate :: Maybe Text

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.

  • scheduleTimezone :: Maybe Text

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

  • startDate :: Maybe Text

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.

  • createdDate :: Maybe POSIX

    The date the maintenance window was created.

  • name :: Maybe Text

    The name of the maintenance window.

  • modifiedDate :: Maybe POSIX

    The date the maintenance window was last modified.

  • cutoff :: Maybe Natural

    The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

  • allowUnassociatedTargets :: Maybe Bool

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

  • description :: Maybe (Sensitive Text)

    The description of the maintenance window.

  • duration :: Maybe Natural

    The duration of the maintenance window in hours.

  • windowId :: Maybe Text

    The ID of the created maintenance window.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

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

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

Show GetMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

showsPrec :: Int -> GetMaintenanceWindowResponse -> ShowS #

show :: GetMaintenanceWindowResponse -> String #

showList :: [GetMaintenanceWindowResponse] -> ShowS #

Generic GetMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Associated Types

type Rep GetMaintenanceWindowResponse :: Type -> Type #

Methods

from :: GetMaintenanceWindowResponse -> Rep GetMaintenanceWindowResponse x #

to :: Rep GetMaintenanceWindowResponse x -> GetMaintenanceWindowResponse #

NFData GetMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

rnf :: GetMaintenanceWindowResponse -> () #

type Rep GetMaintenanceWindowResponse Source # 
Instance details

Defined in Amazonka.SSM.GetMaintenanceWindow

type Rep GetMaintenanceWindowResponse = D1 ('MetaData "GetMaintenanceWindowResponse" "Amazonka.SSM.GetMaintenanceWindow" "libZSservicesZSamazonka-ssmZSamazonka-ssm" 'False) (C1 ('MetaCons "GetMaintenanceWindowResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "schedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextExecutionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduleOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduleTimezone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "modifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "cutoff") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "allowUnassociatedTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetMaintenanceWindowResponse Source #

Arguments

:: Int

$sel:httpStatus:GetMaintenanceWindowResponse'

-> GetMaintenanceWindowResponse 

Create a value of GetMaintenanceWindowResponse 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:enabled:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_enabled - Indicates whether the maintenance window is enabled.

$sel:schedule:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_schedule - The schedule of the maintenance window in the form of a cron or rate expression.

$sel:nextExecutionTime:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_nextExecutionTime - The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

$sel:scheduleOffset:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_scheduleOffset - The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

$sel:endDate:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_endDate - The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.

$sel:scheduleTimezone:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_scheduleTimezone - The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

$sel:startDate:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_startDate - The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.

$sel:createdDate:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_createdDate - The date the maintenance window was created.

$sel:name:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_name - The name of the maintenance window.

$sel:modifiedDate:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_modifiedDate - The date the maintenance window was last modified.

$sel:cutoff:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_cutoff - The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

$sel:allowUnassociatedTargets:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_allowUnassociatedTargets - Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

$sel:description:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_description - The description of the maintenance window.

$sel:duration:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_duration - The duration of the maintenance window in hours.

$sel:windowId:GetMaintenanceWindow', getMaintenanceWindowResponse_windowId - The ID of the created maintenance window.

$sel:httpStatus:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_httpStatus - The response's http status code.

Response Lenses

getMaintenanceWindowResponse_enabled :: Lens' GetMaintenanceWindowResponse (Maybe Bool) Source #

Indicates whether the maintenance window is enabled.

getMaintenanceWindowResponse_schedule :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The schedule of the maintenance window in the form of a cron or rate expression.

getMaintenanceWindowResponse_nextExecutionTime :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

getMaintenanceWindowResponse_scheduleOffset :: Lens' GetMaintenanceWindowResponse (Maybe Natural) Source #

The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

getMaintenanceWindowResponse_endDate :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window won't run after this specified time.

getMaintenanceWindowResponse_scheduleTimezone :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

getMaintenanceWindowResponse_startDate :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window won't run before this specified time.

getMaintenanceWindowResponse_createdDate :: Lens' GetMaintenanceWindowResponse (Maybe UTCTime) Source #

The date the maintenance window was created.

getMaintenanceWindowResponse_name :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The name of the maintenance window.

getMaintenanceWindowResponse_modifiedDate :: Lens' GetMaintenanceWindowResponse (Maybe UTCTime) Source #

The date the maintenance window was last modified.

getMaintenanceWindowResponse_cutoff :: Lens' GetMaintenanceWindowResponse (Maybe Natural) Source #

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

getMaintenanceWindowResponse_allowUnassociatedTargets :: Lens' GetMaintenanceWindowResponse (Maybe Bool) Source #

Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

getMaintenanceWindowResponse_description :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The description of the maintenance window.

getMaintenanceWindowResponse_duration :: Lens' GetMaintenanceWindowResponse (Maybe Natural) Source #

The duration of the maintenance window in hours.

getMaintenanceWindowResponse_windowId :: Lens' GetMaintenanceWindowResponse (Maybe Text) Source #

The ID of the created maintenance window.

getMaintenanceWindowResponse_httpStatus :: Lens' GetMaintenanceWindowResponse Int Source #

The response's http status code.