You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AutoScaling::Types::DescribePoliciesType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass DescribePoliciesType data as a hash:

{
  auto_scaling_group_name: "ResourceName",
  policy_names: ["ResourceName"],
  policy_types: ["XmlStringMaxLen64"],
  next_token: "XmlString",
  max_records: 1,
}

Contains the parameters for DescribePolicies.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the group.

Returns:

  • (String)


1699
1700
1701
1702
1703
1704
1705
1706
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1699

class DescribePoliciesType < Struct.new(
  :auto_scaling_group_name,
  :policy_names,
  :policy_types,
  :next_token,
  :max_records)
  include Aws::Structure
end

#max_recordsInteger

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

Returns:

  • (Integer)


1699
1700
1701
1702
1703
1704
1705
1706
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1699

class DescribePoliciesType < Struct.new(
  :auto_scaling_group_name,
  :policy_names,
  :policy_types,
  :next_token,
  :max_records)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


1699
1700
1701
1702
1703
1704
1705
1706
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1699

class DescribePoliciesType < Struct.new(
  :auto_scaling_group_name,
  :policy_names,
  :policy_types,
  :next_token,
  :max_records)
  include Aws::Structure
end

#policy_namesArray<String>

One or more policy names or policy ARNs to be described. If you omit this parameter, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

Returns:

  • (Array<String>)


1699
1700
1701
1702
1703
1704
1705
1706
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1699

class DescribePoliciesType < Struct.new(
  :auto_scaling_group_name,
  :policy_names,
  :policy_types,
  :next_token,
  :max_records)
  include Aws::Structure
end

#policy_typesArray<String>

One or more policy types. Valid values are SimpleScaling and StepScaling.

Returns:

  • (Array<String>)


1699
1700
1701
1702
1703
1704
1705
1706
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1699

class DescribePoliciesType < Struct.new(
  :auto_scaling_group_name,
  :policy_names,
  :policy_types,
  :next_token,
  :max_records)
  include Aws::Structure
end