EC2 / Client / associate_instance_event_window

associate_instance_event_window

EC2.Client.associate_instance_event_window(**kwargs)

Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window.

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

See also: AWS API Documentation

Request Syntax

response = client.associate_instance_event_window(
    DryRun=True|False,
    InstanceEventWindowId='string',
    AssociationTarget={
        'InstanceIds': [
            'string',
        ],
        'InstanceTags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'DedicatedHostIds': [
            '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.

• InstanceEventWindowId (string) –

  [REQUIRED]

  The ID of the event window.

• AssociationTarget (dict) –

  [REQUIRED]

  One or more targets associated with the specified event window.

  • InstanceIds (list) –

    The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can’t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.

    • (string) –

  • InstanceTags (list) –

    The instance tags to associate 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 to associate with the event window.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'InstanceEventWindow': {
        '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'
            },
        ]
    }
}

Response Structure

• (dict) –

  • InstanceEventWindow (dict) –

    Information about 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.