Struct aws_sdk_ec2::client::fluent_builders::GetSpotPlacementScores

pub struct GetSpotPlacementScores<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to GetSpotPlacementScores.

Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements.

You can specify your compute requirements either by using InstanceRequirementsWithMetadata and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using InstanceTypes.

For more information, see Spot placement score in the Amazon EC2 User Guide.

Implementations

impl<C, M, R> GetSpotPlacementScores<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetSpotPlacementScoresOutput, SdkError<GetSpotPlacementScoresError>> where
    R::Policy: SmithyRetryPolicy<GetSpotPlacementScoresInputOperationOutputAlias, GetSpotPlacementScoresOutput, GetSpotPlacementScoresError, GetSpotPlacementScoresInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> GetSpotPlacementScoresPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn instance_types(self, input: impl Into<String>) -> Self

Appends an item to InstanceTypes.

To override the contents of this collection use set_instance_types.

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.

pub fn set_instance_types(self, input: Option<Vec<String>>) -> Self

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.

pub fn target_capacity(self, input: i32) -> Self

The target capacity.

pub fn set_target_capacity(self, input: Option<i32>) -> Self

The target capacity.

pub fn target_capacity_unit_type(self, input: TargetCapacityUnitType) -> Self

The unit for the target capacity.

Default: units (translates to number of instances)

pub fn set_target_capacity_unit_type(
    self,
    input: Option<TargetCapacityUnitType>
) -> Self

The unit for the target capacity.

Default: units (translates to number of instances)

pub fn single_availability_zone(self, input: bool) -> Self

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.

pub fn set_single_availability_zone(self, input: Option<bool>) -> Self

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.

pub fn region_names(self, input: impl Into<String>) -> Self

Appends an item to RegionNames.

To override the contents of this collection use set_region_names.

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

pub fn set_region_names(self, input: Option<Vec<String>>) -> Self

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

pub fn instance_requirements_with_metadata(
    self,
    input: InstanceRequirementsWithMetadataRequest
) -> Self

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.

pub fn set_instance_requirements_with_metadata(
    self,
    input: Option<InstanceRequirementsWithMetadataRequest>
) -> Self

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.

pub fn dry_run(self, input: bool) -> Self

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.

pub fn set_dry_run(self, input: Option<bool>) -> Self

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.

pub fn max_results(self, input: i32) -> Self

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

pub fn next_token(self, input: impl Into<String>) -> Self

The token for the next set of results.

pub fn set_next_token(self, input: Option<String>) -> Self

The token for the next set of results.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for GetSpotPlacementScores<C, M, R>

fn clone(&self) -> GetSpotPlacementScores<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for GetSpotPlacementScores<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.