java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.DescribeCapacityReservationsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeCapacityReservationsRequest.Builder,DescribeCapacityReservationsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeCapacityReservationsRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeCapacityReservationsRequest.Builder,DescribeCapacityReservationsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeCapacityReservationsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeCapacityReservationsRequest.Builder`	`builder()`
`List<String>`	`capacityReservationIds()`	The ID of the Capacity Reservation.
`Boolean`	`dryRun()`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<Filter>`	`filters()`	One or more filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCapacityReservationIds()`	For responses, this returns true if the service returned a value for the CapacityReservationIds property.
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`Integer`	`maxResults()`	The maximum number of items to return for this request.
`String`	`nextToken()`	The token to use to retrieve the next page of results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeCapacityReservationsRequest.Builder>`	`serializableBuilderClass()`
`DescribeCapacityReservationsRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasCapacityReservationIds
```
public final boolean hasCapacityReservationIds()
```
    For responses, this returns true if the service returned a value for the CapacityReservationIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - capacityReservationIds
```
public final List<String> capacityReservationIds()
```
    The ID of the Capacity Reservation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCapacityReservationIds() method.
    
    Returns:
    
    The ID of the Capacity Reservation.
  - nextToken
```
public final String nextToken()
```
    The token to use to retrieve the next page of results.
    
    Returns:
    
    The token to use to retrieve the next page of results.
  - maxResults
```
public final Integer maxResults()
```
    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.
    
    Returns:
    
    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.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<Filter> filters()
```
    One or more filters.
    
    instance-type - The type of instance for which the Capacity Reservation reserves capacity.
    
    owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
    
    instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
    
    availability-zone - The Availability Zone of the Capacity Reservation.
    
    tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
    
    default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
    
    dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
    
    outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
    
    state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    
    active- The Capacity Reservation is active and the capacity is available for your use.
    
    expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
    
    cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
    
    pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    
    failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
    
    start-date - The date and time at which the Capacity Reservation was started.
    
    end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
    
    end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
    
    unlimited - The Capacity Reservation remains active until you explicitly cancel it.
    
    limited - The Capacity Reservation expires automatically at a specified date and time.
    
    instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
    
    open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
    
    targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
    
    placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    Returns:
    
    One or more filters.
    
    instance-type - The type of instance for which the Capacity Reservation reserves capacity.
    
    owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
    
    instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
    
    availability-zone - The Availability Zone of the Capacity Reservation.
    
    tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
    
    default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
    
    dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
    
    outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
    
    state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    
    active- The Capacity Reservation is active and the capacity is available for your use.
    
    expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
    
    cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
    
    pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
    
    failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
    
    start-date - The date and time at which the Capacity Reservation was started.
    
    end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
    
    end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
    
    unlimited - The Capacity Reservation remains active until you explicitly cancel it.
    
    limited - The Capacity Reservation expires automatically at a specified date and time.
    
    instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
    
    open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
    
    targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
    
    placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
  - dryRun
```
public final Boolean dryRun()
```
    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:
    
    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.
  - toBuilder
```
public DescribeCapacityReservationsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeCapacityReservationsRequest.Builder,DescribeCapacityReservationsRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeCapacityReservationsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeCapacityReservationsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeCapacityReservationsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasCapacityReservationIds

capacityReservationIds

nextToken

maxResults

hasFilters

filters

dryRun

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields