Class: Aws::EC2::Types::GetSpotPlacementScoresRequest

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::GetSpotPlacementScoresRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #instance_requirements_with_metadata ⇒ Types::InstanceRequirementsWithMetadataRequest

  The attributes for the instance types.

• #instance_types ⇒ Array<String>

  The instance types.

• #max_results ⇒ Integer

  The maximum number of items to return for this request.

• #next_token ⇒ String

  The token returned from a previous paginated request.

• #region_names ⇒ Array<String>

  The Regions used to narrow down the list of Regions to be scored.

• #single_availability_zone ⇒ Boolean

  Specify ‘true` so that the response returns a list of scored Availability Zones.

• #target_capacity ⇒ Integer

  The target capacity.

• #target_capacity_unit_type ⇒ String

  The unit for the target capacity.

Instance Attribute Details

#dry_run ⇒ 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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_requirements_with_metadata ⇒ Types::InstanceRequirementsWithMetadataRequest

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify ‘InstanceRequirementsWithMetadata`, you can’t specify ‘InstanceTypes`.

Returns:

• (Types::InstanceRequirementsWithMetadataRequest)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_types ⇒ Array<String>

The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an ‘m3.xlarge` with and without instance storage), the returned placement score will always be low.

If you specify ‘InstanceTypes`, you can’t specify ‘InstanceRequirementsWithMetadata`.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination].

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#region_names ⇒ Array<String>

The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, ‘us-east-1`.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#single_availability_zone ⇒ Boolean

Specify ‘true` so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.

A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_capacity ⇒ Integer

The target capacity.

Returns:

• (Integer)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_capacity_unit_type ⇒ String

The unit for the target capacity.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 35746

class GetSpotPlacementScoresRequest < Struct.new(
  :instance_types,
  :target_capacity,
  :target_capacity_unit_type,
  :single_availability_zone,
  :region_names,
  :instance_requirements_with_metadata,
  :dry_run,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end