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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $ec2 = Paws->service('EC2');
my $DescribeHostsResult = $ec2->DescribeHosts(
  Filter => [
    {
      Name   => 'MyString',    # OPTIONAL
      Values => [
        'MyString', ...        # OPTIONAL
      ],    # OPTIONAL
    },
    ...
  ],    # OPTIONAL
  HostIds    => [ 'MyDedicatedHostId', ... ],    # OPTIONAL
  MaxResults => 1,                               # OPTIONAL
  NextToken  => 'MyString',                      # OPTIONAL
);

# Results:
my $Hosts     = $DescribeHostsResult->Hosts;
my $NextToken = $DescribeHostsResult->NextToken;

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

ATTRIBUTES

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

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • 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.

HostIds => ArrayRef[Str|Undef]

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

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.

You cannot specify this parameter and the host IDs parameter in the same request.

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