EC2 / Client / describe_instance_event_windows

describe_instance_event_windows#

EC2.Client.describe_instance_event_windows(**kwargs)#

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.

Request Syntax

response = client.describe_instance_event_windows(
    DryRun=True|False,
    InstanceEventWindowIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

DryRun (boolean) – 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.
InstanceEventWindowIds (list) –
The IDs of the event windows.
- (string) –
Filters (list) –
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.
- (dict) –
  
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
  
  If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
  - Name (string) –
    
    The name of the filter. Filter names are case-sensitive.
  - Values (list) –
    
    The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.
    - (string) –
MaxResults (integer) – 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 (string) – The token to request the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'InstanceEventWindows': [
        {
            'InstanceEventWindowId': 'string',
            'TimeRanges': [
                {
                    'StartWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday',
                    'StartHour': 123,
                    'EndWeekDay': 'sunday'|'monday'|'tuesday'|'wednesday'|'thursday'|'friday'|'saturday',
                    'EndHour': 123
                },
            ],
            'Name': 'string',
            'CronExpression': 'string',
            'AssociationTarget': {
                'InstanceIds': [
                    'string',
                ],
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ],
                'DedicatedHostIds': [
                    'string',
                ]
            },
            'State': 'creating'|'deleting'|'active'|'deleted',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- InstanceEventWindows (list) –
  
  Information about the event windows.
  - (dict) –
    
    The event window.
    - InstanceEventWindowId (string) –
      
      The ID of the event window.
    - TimeRanges (list) –
      
      One or more time ranges defined for the event window.
      - (dict) –
        
        The start day and time and the end day and time of the time range, in UTC.
        
        StartWeekDay (string) –
        
        The day on which the time range begins.
        
        StartHour (integer) –
        
        The hour when the time range begins.
        
        EndWeekDay (string) –
        
        The day on which the time range ends.
        
        EndHour (integer) –
        
        The hour when the time range ends.
    - Name (string) –
      
      The name of the event window.
    - CronExpression (string) –
      
      The cron expression defined for the event window.
    - AssociationTarget (dict) –
      
      One or more targets associated with the event window.
      - InstanceIds (list) –
        
        The IDs of the instances associated with the event window.
        
        (string) –
      - Tags (list) –
        
        The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.
        
        (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
      - DedicatedHostIds (list) –
        
        The IDs of the Dedicated Hosts associated with the event window.
        
        (string) –
    - State (string) –
      
      The current state of the event window.
    - Tags (list) –
      
      The instance tags associated with the event window.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- NextToken (string) –
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.