/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::EC2::DescribeCapacityReservations

NAME

Paws::EC2::DescribeCapacityReservations - Arguments for method DescribeCapacityReservations on Paws::EC2

DESCRIPTION

This class represents the parameters used for calling the method DescribeCapacityReservations on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method DescribeCapacityReservations.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCapacityReservations.

SYNOPSIS

my $ec2 = Paws->service('EC2');
my $DescribeCapacityReservationsResult = $ec2->DescribeCapacityReservations(
  CapacityReservationIds => [ 'MyCapacityReservationId', ... ],   # OPTIONAL
  DryRun                 => 1,                                    # OPTIONAL
  Filters                => [
    {
      Name   => 'MyString',                                       # OPTIONAL
      Values => [
        'MyString', ...                                           # OPTIONAL
      ],    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  MaxResults => 1,             # OPTIONAL
  NextToken  => 'MyString',    # OPTIONAL
);

# Results:
my $CapacityReservations =
  $DescribeCapacityReservationsResult->CapacityReservations;
my $NextToken = $DescribeCapacityReservationsResult->NextToken;

# Returns a L<Paws::EC2::DescribeCapacityReservationsResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeCapacityReservations

ATTRIBUTES

CapacityReservationIds => ArrayRef[Str|Undef]

The ID of the Capacity Reservation.

DryRun => Bool

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.

Filters => ArrayRef[Paws::EC2::Filter]

One or more filters.

  • instance-type - The type of instance for which the Capacity Reservation reserves capacity.

  • owner-id - The ID of the account that owns the Capacity Reservation.

  • availability-zone-id - The Availability Zone ID of the Capacity Reservation.

  • instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.

  • availability-zone - The Availability Zone ID 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 accounts.

    • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single 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.

MaxResults => Int

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

NextToken => Str

The token to use to retrieve the next page of results.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeCapacityReservations in Paws::EC2

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues