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

Description

Describes the specified event windows or all event windows.

If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeInstanceEventWindows Source #

Describe instance event windows by InstanceEventWindow.

See: newDescribeInstanceEventWindows smart constructor.

Constructors

DescribeInstanceEventWindows' 

Fields

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

  • filters :: Maybe [Filter]

    One or more filters.

    • dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
    • event-window-name - The event windows associated with the specified names.
    • instance-id - The event windows associated with the specified instance ID.
    • instance-tag - The event windows associated with the specified tag and value.
    • instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
    • instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
    • tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
    • tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
    • tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
  • instanceEventWindowIds :: Maybe [Text]

    The IDs of the event windows.

  • maxResults :: Maybe Natural

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.

  • nextToken :: Maybe Text

    The token to request the next page of results.

Instances

Instances details
ToHeaders DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

toHeaders :: DescribeInstanceEventWindows -> [Header] #

ToPath DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

toPath :: DescribeInstanceEventWindows -> ByteString #

ToQuery DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

toQuery :: DescribeInstanceEventWindows -> QueryString #

AWSPager DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

page :: DescribeInstanceEventWindows -> AWSResponse DescribeInstanceEventWindows -> Maybe DescribeInstanceEventWindows #

AWSRequest DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Associated Types

type AWSResponse DescribeInstanceEventWindows #

Methods

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

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

Generic DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Associated Types

type Rep DescribeInstanceEventWindows :: Type -> Type #

Methods

from :: DescribeInstanceEventWindows -> Rep DescribeInstanceEventWindows x #

to :: Rep DescribeInstanceEventWindows x -> DescribeInstanceEventWindows #

Read DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

readsPrec :: Int -> ReadS DescribeInstanceEventWindows #

readList :: ReadS [DescribeInstanceEventWindows] #

readPrec :: ReadPrec DescribeInstanceEventWindows #

readListPrec :: ReadPrec [DescribeInstanceEventWindows] #

Show DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

showsPrec :: Int -> DescribeInstanceEventWindows -> ShowS #

show :: DescribeInstanceEventWindows -> String #

showList :: [DescribeInstanceEventWindows] -> ShowS #

NFData DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

rnf :: DescribeInstanceEventWindows -> () #

Eq DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

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

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

Hashable DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

hashWithSalt :: Int -> DescribeInstanceEventWindows -> Int #

hash :: DescribeInstanceEventWindows -> Int #

type AWSResponse DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

type AWSResponse DescribeInstanceEventWindows = DescribeInstanceEventWindowsResponse
type Rep DescribeInstanceEventWindows Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

type Rep DescribeInstanceEventWindows = D1 ('MetaData "DescribeInstanceEventWindows" "Amazonka.EC2.DescribeInstanceEventWindows" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeInstanceEventWindows'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :*: (S1 ('MetaSel ('Just "instanceEventWindowIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeInstanceEventWindows :: DescribeInstanceEventWindows Source #

Create a value of DescribeInstanceEventWindows 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:dryRun:DescribeInstanceEventWindows', describeInstanceEventWindows_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.

$sel:filters:DescribeInstanceEventWindows', describeInstanceEventWindows_filters - One or more filters.

  • dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
  • event-window-name - The event windows associated with the specified names.
  • instance-id - The event windows associated with the specified instance ID.
  • instance-tag - The event windows associated with the specified tag and value.
  • instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
  • instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
  • tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
  • tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
  • tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.

$sel:instanceEventWindowIds:DescribeInstanceEventWindows', describeInstanceEventWindows_instanceEventWindowIds - The IDs of the event windows.

$sel:maxResults:DescribeInstanceEventWindows', describeInstanceEventWindows_maxResults - The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.

DescribeInstanceEventWindows, describeInstanceEventWindows_nextToken - The token to request the next page of results.

Request Lenses

describeInstanceEventWindows_dryRun :: Lens' DescribeInstanceEventWindows (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.

describeInstanceEventWindows_filters :: Lens' DescribeInstanceEventWindows (Maybe [Filter]) Source #

One or more filters.

  • dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
  • event-window-name - The event windows associated with the specified names.
  • instance-id - The event windows associated with the specified instance ID.
  • instance-tag - The event windows associated with the specified tag and value.
  • instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
  • instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
  • tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
  • tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
  • tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.

describeInstanceEventWindows_instanceEventWindowIds :: Lens' DescribeInstanceEventWindows (Maybe [Text]) Source #

The IDs of the event windows.

describeInstanceEventWindows_maxResults :: Lens' DescribeInstanceEventWindows (Maybe Natural) Source #

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.

describeInstanceEventWindows_nextToken :: Lens' DescribeInstanceEventWindows (Maybe Text) Source #

The token to request the next page of results.

Destructuring the Response

data DescribeInstanceEventWindowsResponse Source #

See: newDescribeInstanceEventWindowsResponse smart constructor.

Constructors

DescribeInstanceEventWindowsResponse' 

Fields

Instances

Instances details
Generic DescribeInstanceEventWindowsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Associated Types

type Rep DescribeInstanceEventWindowsResponse :: Type -> Type #

Methods

from :: DescribeInstanceEventWindowsResponse -> Rep DescribeInstanceEventWindowsResponse x #

to :: Rep DescribeInstanceEventWindowsResponse x -> DescribeInstanceEventWindowsResponse #

Read DescribeInstanceEventWindowsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

readsPrec :: Int -> ReadS DescribeInstanceEventWindowsResponse #

readList :: ReadS [DescribeInstanceEventWindowsResponse] #

readPrec :: ReadPrec DescribeInstanceEventWindowsResponse #

readListPrec :: ReadPrec [DescribeInstanceEventWindowsResponse] #

Show DescribeInstanceEventWindowsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

showsPrec :: Int -> DescribeInstanceEventWindowsResponse -> ShowS #

show :: DescribeInstanceEventWindowsResponse -> String #

showList :: [DescribeInstanceEventWindowsResponse] -> ShowS #

NFData DescribeInstanceEventWindowsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

rnf :: DescribeInstanceEventWindowsResponse -> () #

Eq DescribeInstanceEventWindowsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

Methods

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

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

type Rep DescribeInstanceEventWindowsResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeInstanceEventWindows

type Rep DescribeInstanceEventWindowsResponse = D1 ('MetaData "DescribeInstanceEventWindowsResponse" "Amazonka.EC2.DescribeInstanceEventWindows" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeInstanceEventWindowsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceEventWindows") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceEventWindow])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeInstanceEventWindowsResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeInstanceEventWindowsResponse'

-> DescribeInstanceEventWindowsResponse 

Create a value of DescribeInstanceEventWindowsResponse 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:instanceEventWindows:DescribeInstanceEventWindowsResponse', describeInstanceEventWindowsResponse_instanceEventWindows - Information about the event windows.

DescribeInstanceEventWindows, describeInstanceEventWindowsResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

$sel:httpStatus:DescribeInstanceEventWindowsResponse', describeInstanceEventWindowsResponse_httpStatus - The response's http status code.

Response Lenses

describeInstanceEventWindowsResponse_instanceEventWindows :: Lens' DescribeInstanceEventWindowsResponse (Maybe [InstanceEventWindow]) Source #

Information about the event windows.

describeInstanceEventWindowsResponse_nextToken :: Lens' DescribeInstanceEventWindowsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

describeInstanceEventWindowsResponse_httpStatus :: Lens' DescribeInstanceEventWindowsResponse Int Source #

The response's http status code.