Skip to content

DescribeScalingActivitiesType

Source code in docs_src/capo_auto_scaling/types/describe_scaling_activities_type.py
class DescribeScalingActivitiesType(TypedDict, closed=True):
    activity_ids: NotRequired["capo_auto_scaling.types.activity_ids.ActivityIds"]
    """<p> The activity IDs of the desired scaling activities. If unknown activity IDs are requested, they are ignored with no error. Only activities started within the last six weeks can be returned regardless of the activity IDs specified. If other filters are specified with the request, only results matching all filter criteria can be returned. </p> <p>Array Members: Maximum number of 50 IDs.</p>"""
    auto_scaling_group_name: NotRequired[
        "capo_auto_scaling.types.xml_string_max_len255.XmlStringMaxLen255"
    ]
    """<p>The name of the Auto Scaling group.</p> <important> <p> Omitting this property performs an account-wide operation, which can result in slower or timed-out requests. </p> </important>"""
    include_deleted_groups: NotRequired[
        "capo_auto_scaling.types.include_deleted_groups.IncludeDeletedGroups"
    ]
    """<p>Indicates whether to include scaling activity from deleted Auto Scaling groups.</p>"""
    max_records: NotRequired["capo_auto_scaling.types.max_records.MaxRecords"]
    """<p>The maximum number of items to return with this call. The default value is <code>100</code> and the maximum value is <code>100</code>.</p>"""
    next_token: NotRequired["capo_auto_scaling.types.xml_string.XmlString"]
    """<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"""
    filters: NotRequired["capo_auto_scaling.types.filters.Filters"]
    """<p> One or more filters to limit the results based on specific criteria. The following filters are supported: </p> <ul> <li> <p> <code>StartTimeLowerBound</code> - The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. </p> </li> <li> <p> <code>StartTimeUpperBound</code> - The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified. </p> </li> <li> <p> <code>Status</code> - The <code>StatusCode</code> value of the scaling activity. This filter can only be used in combination with the <code>AutoScalingGroupName</code> parameter. For valid <code>StatusCode</code> values, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Activity.html">Activity</a> in the <i>Amazon EC2 Auto Scaling API Reference</i>. </p> </li> </ul> <p> <code>StartTimeLowerBound</code> and <code>StartTimeUpperBound</code> accept ISO 8601 formatted timestamps. Timestamps without a timezone offset are assumed to be UTC. </p> <ul> <li> <p> <code>2000-01-18T08:15:00Z</code> </p> </li> <li> <p> <code>2000-01-18T16:15:00+08:00</code> </p> </li> </ul>"""

activity_ids instance-attribute

activity_ids: NotRequired[ActivityIds]

The activity IDs of the desired scaling activities. If unknown activity IDs are requested, they are ignored with no error. Only activities started within the last six weeks can be returned regardless of the activity IDs specified. If other filters are specified with the request, only results matching all filter criteria can be returned.

Array Members: Maximum number of 50 IDs.

auto_scaling_group_name instance-attribute

auto_scaling_group_name: NotRequired[XmlStringMaxLen255]

The name of the Auto Scaling group.

Omitting this property performs an account-wide operation, which can result in slower or timed-out requests.

filters instance-attribute

filters: NotRequired[Filters]

One or more filters to limit the results based on specific criteria. The following filters are supported:

  • StartTimeLowerBound - The earliest scaling activities to return based on the activity start time. Scaling activities with a start time earlier than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

  • StartTimeUpperBound - The latest scaling activities to return based on the activity start time. Scaling activities with a start time later than this value are not included in the results. Only activities started within the last six weeks can be returned regardless of the value specified.

  • Status - The StatusCode value of the scaling activity. This filter can only be used in combination with the AutoScalingGroupName parameter. For valid StatusCode values, see Activity in the Amazon EC2 Auto Scaling API Reference.

StartTimeLowerBound and StartTimeUpperBound accept ISO 8601 formatted timestamps. Timestamps without a timezone offset are assumed to be UTC.

  • 2000-01-18T08:15:00Z

  • 2000-01-18T16:15:00+08:00

include_deleted_groups instance-attribute

include_deleted_groups: NotRequired[IncludeDeletedGroups]

Indicates whether to include scaling activity from deleted Auto Scaling groups.

max_records instance-attribute

max_records: NotRequired[MaxRecords]

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

next_token instance-attribute

next_token: NotRequired[XmlString]

The token for the next set of items to return. (You received this token from a previous call.)