The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $ec2 = Paws->service('EC2');
    my $DescribeHostReservationsResult = $ec2->DescribeHostReservations(
      Filter => [
        {
          Name   => 'MyString',    # OPTIONAL
          Values => [
            'MyString', ...        # OPTIONAL
          ],    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      HostReservationIdSet => [ 'MyHostReservationId', ... ],    # OPTIONAL
      MaxResults           => 1,                                 # OPTIONAL
      NextToken            => 'MyString',                        # OPTIONAL
    );

    # Results:
    my $HostReservationSet =
      $DescribeHostReservationsResult->HostReservationSet;
    my $NextToken = $DescribeHostReservationsResult->NextToken;

    # Returns a L<Paws::EC2::DescribeHostReservationsResult> 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/DescribeHostReservations

ATTRIBUTES

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

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

HostReservationIdSet => ArrayRef[Str|Undef]

The host reservation IDs.

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 DescribeHostReservations 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