OpsWorks / Client / describe_time_based_auto_scaling

describe_time_based_auto_scaling

OpsWorks.Client.describe_time_based_auto_scaling(**kwargs)

Describes time-based auto scaling configurations for specified instances.

Note

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.describe_time_based_auto_scaling(
    InstanceIds=[
        'string',
    ]
)

Parameters:

InstanceIds (list) –

[REQUIRED]

An array of instance IDs.

• (string) –

Return type:

dict

Returns:

Response Syntax

{
    'TimeBasedAutoScalingConfigurations': [
        {
            'InstanceId': 'string',
            'AutoScalingSchedule': {
                'Monday': {
                    'string': 'string'
                },
                'Tuesday': {
                    'string': 'string'
                },
                'Wednesday': {
                    'string': 'string'
                },
                'Thursday': {
                    'string': 'string'
                },
                'Friday': {
                    'string': 'string'
                },
                'Saturday': {
                    'string': 'string'
                },
                'Sunday': {
                    'string': 'string'
                }
            }
        },
    ]
}

Response Structure

• (dict) –

  Contains the response to a DescribeTimeBasedAutoScaling request.

  • TimeBasedAutoScalingConfigurations (list) –

    An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

    • (dict) –

      Describes an instance’s time-based auto scaling configuration.

      • InstanceId (string) –

        The instance ID.

      • AutoScalingSchedule (dict) –

        A WeeklyAutoScalingSchedule object with the instance schedule.

        • Monday (dict) –

          The schedule for Monday.

          • (string) –

            • (string) –

        • Tuesday (dict) –

          The schedule for Tuesday.

          • (string) –

            • (string) –

        • Wednesday (dict) –

          The schedule for Wednesday.

          • (string) –

            • (string) –

        • Thursday (dict) –

          The schedule for Thursday.

          • (string) –

            • (string) –

        • Friday (dict) –

          The schedule for Friday.

          • (string) –

            • (string) –

        • Saturday (dict) –

          The schedule for Saturday.

          • (string) –

            • (string) –

        • Sunday (dict) –

          The schedule for Sunday.

          • (string) –

            • (string) –

Exceptions

• OpsWorks.Client.exceptions.ValidationException

• OpsWorks.Client.exceptions.ResourceNotFoundException