amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.ModifyInstanceEventWindow

Description

Modifies the specified event window.

You can define either a set of time ranges or a cron expression when modifying the event window, but not both.

To modify the targets associated with the event window, use the AssociateInstanceEventWindow and DisassociateInstanceEventWindow API.

If Amazon Web Services has already scheduled an event, modifying an event window won't change the time of the scheduled event.

For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.

Synopsis

Creating a Request

data ModifyInstanceEventWindow Source #

See: newModifyInstanceEventWindow smart constructor.

Constructors

ModifyInstanceEventWindow' 

Fields

  • cronExpression :: Maybe Text

    The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

    Constraints:

    • Only hour and day of the week values are supported.
    • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
    • The minute, month, and year must be specified by *.
    • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
    • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
    • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

    For more information about cron expressions, see cron on the Wikipedia website.

  • dryRun :: Maybe Bool

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • name :: Maybe Text

    The name of the event window.

  • timeRanges :: Maybe [InstanceEventWindowTimeRangeRequest]

    The time ranges of the event window.

  • instanceEventWindowId :: Text

    The ID of the event window.

Instances

Instances details
ToHeaders ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

toHeaders :: ModifyInstanceEventWindow -> [Header] #

ToPath ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

toPath :: ModifyInstanceEventWindow -> ByteString #

ToQuery ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

toQuery :: ModifyInstanceEventWindow -> QueryString #

AWSRequest ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Associated Types

type AWSResponse ModifyInstanceEventWindow #

Methods

request :: (Service -> Service) -> ModifyInstanceEventWindow -> Request ModifyInstanceEventWindow #

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

Generic ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Associated Types

type Rep ModifyInstanceEventWindow :: Type -> Type #

Methods

from :: ModifyInstanceEventWindow -> Rep ModifyInstanceEventWindow x #

to :: Rep ModifyInstanceEventWindow x -> ModifyInstanceEventWindow #

Read ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

readsPrec :: Int -> ReadS ModifyInstanceEventWindow #

readList :: ReadS [ModifyInstanceEventWindow] #

readPrec :: ReadPrec ModifyInstanceEventWindow #

readListPrec :: ReadPrec [ModifyInstanceEventWindow] #

Show ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

showsPrec :: Int -> ModifyInstanceEventWindow -> ShowS #

show :: ModifyInstanceEventWindow -> String #

showList :: [ModifyInstanceEventWindow] -> ShowS #

NFData ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

rnf :: ModifyInstanceEventWindow -> () #

Eq ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

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

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

Hashable ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

hashWithSalt :: Int -> ModifyInstanceEventWindow -> Int #

hash :: ModifyInstanceEventWindow -> Int #

type AWSResponse ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

type AWSResponse ModifyInstanceEventWindow = ModifyInstanceEventWindowResponse
type Rep ModifyInstanceEventWindow Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

type Rep ModifyInstanceEventWindow = D1 ('MetaData "ModifyInstanceEventWindow" "Amazonka.EC2.ModifyInstanceEventWindow" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyInstanceEventWindow'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cronExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "timeRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceEventWindowTimeRangeRequest])) :*: S1 ('MetaSel ('Just "instanceEventWindowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newModifyInstanceEventWindow Source #

Arguments

:: Text

ModifyInstanceEventWindow

-> ModifyInstanceEventWindow 

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

ModifyInstanceEventWindow, modifyInstanceEventWindow_cronExpression - The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

Constraints:

  • Only hour and day of the week values are supported.
  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
  • The minute, month, and year must be specified by *.
  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

$sel:dryRun:ModifyInstanceEventWindow', modifyInstanceEventWindow_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

ModifyInstanceEventWindow, modifyInstanceEventWindow_name - The name of the event window.

ModifyInstanceEventWindow, modifyInstanceEventWindow_timeRanges - The time ranges of the event window.

ModifyInstanceEventWindow, modifyInstanceEventWindow_instanceEventWindowId - The ID of the event window.

Request Lenses

modifyInstanceEventWindow_cronExpression :: Lens' ModifyInstanceEventWindow (Maybe Text) Source #

The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.

Constraints:

  • Only hour and day of the week values are supported.
  • For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
  • The minute, month, and year must be specified by *.
  • The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
  • Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
  • The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.

For more information about cron expressions, see cron on the Wikipedia website.

modifyInstanceEventWindow_dryRun :: Lens' ModifyInstanceEventWindow (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

modifyInstanceEventWindow_name :: Lens' ModifyInstanceEventWindow (Maybe Text) Source #

The name of the event window.

modifyInstanceEventWindow_timeRanges :: Lens' ModifyInstanceEventWindow (Maybe [InstanceEventWindowTimeRangeRequest]) Source #

The time ranges of the event window.

modifyInstanceEventWindow_instanceEventWindowId :: Lens' ModifyInstanceEventWindow Text Source #

The ID of the event window.

Destructuring the Response

data ModifyInstanceEventWindowResponse Source #

See: newModifyInstanceEventWindowResponse smart constructor.

Constructors

ModifyInstanceEventWindowResponse' 

Fields

Instances

Instances details
Generic ModifyInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Associated Types

type Rep ModifyInstanceEventWindowResponse :: Type -> Type #

Methods

from :: ModifyInstanceEventWindowResponse -> Rep ModifyInstanceEventWindowResponse x #

to :: Rep ModifyInstanceEventWindowResponse x -> ModifyInstanceEventWindowResponse #

Read ModifyInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

readsPrec :: Int -> ReadS ModifyInstanceEventWindowResponse #

readList :: ReadS [ModifyInstanceEventWindowResponse] #

readPrec :: ReadPrec ModifyInstanceEventWindowResponse #

readListPrec :: ReadPrec [ModifyInstanceEventWindowResponse] #

Show ModifyInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

showsPrec :: Int -> ModifyInstanceEventWindowResponse -> ShowS #

show :: ModifyInstanceEventWindowResponse -> String #

showList :: [ModifyInstanceEventWindowResponse] -> ShowS #

NFData ModifyInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

rnf :: ModifyInstanceEventWindowResponse -> () #

Eq ModifyInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

Methods

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

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

type Rep ModifyInstanceEventWindowResponse Source # 
Instance details

Defined in Amazonka.EC2.ModifyInstanceEventWindow

type Rep ModifyInstanceEventWindowResponse = D1 ('MetaData "ModifyInstanceEventWindowResponse" "Amazonka.EC2.ModifyInstanceEventWindow" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyInstanceEventWindowResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceEventWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceEventWindow)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newModifyInstanceEventWindowResponse Source #

Arguments

:: Int

$sel:httpStatus:ModifyInstanceEventWindowResponse'

-> ModifyInstanceEventWindowResponse 

Create a value of ModifyInstanceEventWindowResponse 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:instanceEventWindow:ModifyInstanceEventWindowResponse', modifyInstanceEventWindowResponse_instanceEventWindow - Information about the event window.

$sel:httpStatus:ModifyInstanceEventWindowResponse', modifyInstanceEventWindowResponse_httpStatus - The response's http status code.

Response Lenses

modifyInstanceEventWindowResponse_instanceEventWindow :: Lens' ModifyInstanceEventWindowResponse (Maybe InstanceEventWindow) Source #

Information about the event window.

modifyInstanceEventWindowResponse_httpStatus :: Lens' ModifyInstanceEventWindowResponse Int Source #

The response's http status code.