Amazonka.SSM.GetMaintenanceWindow

Retrieves a maintenance window.

Creating a Request

data GetMaintenanceWindow

See: newGetMaintenanceWindow smart constructor.

Constructors

GetMaintenanceWindow'

Fields

• windowId :: Text

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

Instances

ToJSON GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toJSON :: GetMaintenanceWindow -> Value

toEncoding :: GetMaintenanceWindow -> Encoding

toJSONList :: [GetMaintenanceWindow] -> Value

toEncodingList :: [GetMaintenanceWindow] -> Encoding

ToHeaders GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toHeaders :: GetMaintenanceWindow -> [Header]

ToPath GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toPath :: GetMaintenanceWindow -> ByteString

ToQuery GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

toQuery :: GetMaintenanceWindow -> QueryString

AWSRequest GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Associated Types

type AWSResponse GetMaintenanceWindow

Methods

request :: (Service -> Service) -> GetMaintenanceWindow -> Request GetMaintenanceWindow

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

Generic GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Associated Types

type Rep GetMaintenanceWindow :: Type -> Type

Methods

from :: GetMaintenanceWindow -> Rep GetMaintenanceWindow x

to :: Rep GetMaintenanceWindow x -> GetMaintenanceWindow

Read GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

readsPrec :: Int -> ReadS GetMaintenanceWindow

readList :: ReadS [GetMaintenanceWindow]

readPrec :: ReadPrec GetMaintenanceWindow

readListPrec :: ReadPrec [GetMaintenanceWindow]

Show GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

showsPrec :: Int -> GetMaintenanceWindow -> ShowS

show :: GetMaintenanceWindow -> String

showList :: [GetMaintenanceWindow] -> ShowS

NFData GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

rnf :: GetMaintenanceWindow -> ()

Eq GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

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

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

Hashable GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

hashWithSalt :: Int -> GetMaintenanceWindow -> Int

hash :: GetMaintenanceWindow -> Int

type AWSResponse GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

type AWSResponse GetMaintenanceWindow = GetMaintenanceWindowResponse

type Rep GetMaintenanceWindow

Defined in Amazonka.SSM.GetMaintenanceWindow

type Rep GetMaintenanceWindow = D1 ('MetaData "GetMaintenanceWindow" "Amazonka.SSM.GetMaintenanceWindow" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "GetMaintenanceWindow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "windowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetMaintenanceWindow

Arguments

:: Text

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:

GetMaintenanceWindow, getMaintenanceWindow_windowId - The ID of the maintenance window for which you want to retrieve information.

Request Lenses

getMaintenanceWindow_windowId :: Lens' GetMaintenanceWindow Text

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

Destructuring the Response

data GetMaintenanceWindowResponse

See: newGetMaintenanceWindowResponse smart constructor.

Constructors

GetMaintenanceWindowResponse'

Fields

• allowUnassociatedTargets :: Maybe Bool

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

• createdDate :: Maybe POSIX

  The date the maintenance window was created.

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

• description :: Maybe (Sensitive Text)

  The description of the maintenance window.

• duration :: Maybe Natural

  The duration of the maintenance window in hours.

• enabled :: Maybe Bool

  Indicates whether the maintenance window is enabled.

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

• modifiedDate :: Maybe POSIX

  The date the maintenance window was last modified.

• name :: Maybe Text

  The name of the maintenance window.

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

• schedule :: Maybe Text

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

• scheduleOffset :: Maybe Natural

  The number of days to wait to run a maintenance window after the scheduled cron expression date and 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.

• windowId :: Maybe Text

  The ID of the created maintenance window.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetMaintenanceWindowResponse

Defined in Amazonka.SSM.GetMaintenanceWindow

Associated Types

type Rep GetMaintenanceWindowResponse :: Type -> Type

Methods

from :: GetMaintenanceWindowResponse -> Rep GetMaintenanceWindowResponse x

to :: Rep GetMaintenanceWindowResponse x -> GetMaintenanceWindowResponse

Show GetMaintenanceWindowResponse

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

showsPrec :: Int -> GetMaintenanceWindowResponse -> ShowS

show :: GetMaintenanceWindowResponse -> String

showList :: [GetMaintenanceWindowResponse] -> ShowS

NFData GetMaintenanceWindowResponse

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

rnf :: GetMaintenanceWindowResponse -> ()

Eq GetMaintenanceWindowResponse

Defined in Amazonka.SSM.GetMaintenanceWindow

Methods

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

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

type Rep GetMaintenanceWindowResponse

Defined in Amazonka.SSM.GetMaintenanceWindow

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

newGetMaintenanceWindowResponse

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:allowUnassociatedTargets:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_allowUnassociatedTargets - Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

GetMaintenanceWindowResponse, getMaintenanceWindowResponse_createdDate - The date the maintenance window was created.

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.

GetMaintenanceWindowResponse, getMaintenanceWindowResponse_description - The description of the maintenance window.

GetMaintenanceWindowResponse, getMaintenanceWindowResponse_duration - The duration of the maintenance window in hours.

GetMaintenanceWindowResponse, getMaintenanceWindowResponse_enabled - Indicates whether the maintenance window is enabled.

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:modifiedDate:GetMaintenanceWindowResponse', getMaintenanceWindowResponse_modifiedDate - The date the maintenance window was last modified.

GetMaintenanceWindowResponse, getMaintenanceWindowResponse_name - The name of the maintenance window.

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.

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

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

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.

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.

GetMaintenanceWindow, getMaintenanceWindowResponse_windowId - The ID of the created maintenance window.

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

Response Lenses

getMaintenanceWindowResponse_allowUnassociatedTargets :: Lens' GetMaintenanceWindowResponse (Maybe Bool)

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

getMaintenanceWindowResponse_createdDate :: Lens' GetMaintenanceWindowResponse (Maybe UTCTime)

The date the maintenance window was created.

getMaintenanceWindowResponse_cutoff :: Lens' GetMaintenanceWindowResponse (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.

getMaintenanceWindowResponse_description :: Lens' GetMaintenanceWindowResponse (Maybe Text)

The description of the maintenance window.

getMaintenanceWindowResponse_duration :: Lens' GetMaintenanceWindowResponse (Maybe Natural)

The duration of the maintenance window in hours.

getMaintenanceWindowResponse_enabled :: Lens' GetMaintenanceWindowResponse (Maybe Bool)

Indicates whether the maintenance window is enabled.

getMaintenanceWindowResponse_endDate :: Lens' GetMaintenanceWindowResponse (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.

getMaintenanceWindowResponse_modifiedDate :: Lens' GetMaintenanceWindowResponse (Maybe UTCTime)

The date the maintenance window was last modified.

getMaintenanceWindowResponse_name :: Lens' GetMaintenanceWindowResponse (Maybe Text)

The name of the maintenance window.

getMaintenanceWindowResponse_nextExecutionTime :: Lens' GetMaintenanceWindowResponse (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.

getMaintenanceWindowResponse_schedule :: Lens' GetMaintenanceWindowResponse (Maybe Text)

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

getMaintenanceWindowResponse_scheduleOffset :: Lens' GetMaintenanceWindowResponse (Maybe Natural)

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

getMaintenanceWindowResponse_scheduleTimezone :: Lens' GetMaintenanceWindowResponse (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.

getMaintenanceWindowResponse_startDate :: Lens' GetMaintenanceWindowResponse (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.

getMaintenanceWindowResponse_windowId :: Lens' GetMaintenanceWindowResponse (Maybe Text)

The ID of the created maintenance window.

getMaintenanceWindowResponse_httpStatus :: Lens' GetMaintenanceWindowResponse Int

The response's http status code.