Class: Aws::SSM::Types::DescribeInstanceInformationRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::DescribeInstanceInformationRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DescribeInstanceInformationRequest data as a hash:

{
  instance_information_filter_list: [
    {
      key: "InstanceIds", # required, accepts InstanceIds, AgentVersion, PingStatus, PlatformTypes, ActivationIds, IamRole, ResourceType, AssociationStatus
      value_set: ["InstanceInformationFilterValue"], # required
    },
  ],
  filters: [
    {
      key: "InstanceInformationStringFilterKey", # required
      values: ["InstanceInformationFilterValue"], # required
    },
  ],
  max_results: 1,
  next_token: "NextToken",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #filters ⇒ Array<Types::InstanceInformationStringFilter>

  One or more filters.

• #instance_information_filter_list ⇒ Array<Types::InstanceInformationFilter>

  This is a legacy method.

• #max_results ⇒ Integer

  The maximum number of items to return for this call.

• #next_token ⇒ String

  The token for the next set of items to return.

Instance Attribute Details

#filters ⇒ Array<Types::InstanceInformationStringFilter>

One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.

Returns:

• (Array<Types::InstanceInformationStringFilter>)

# File 'lib/aws-sdk-ssm/types.rb', line 4522

class DescribeInstanceInformationRequest < Struct.new(
  :instance_information_filter_list,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#instance_information_filter_list ⇒ Array<Types::InstanceInformationFilter>

This is a legacy method. We recommend that you don’t use this method. Instead, use the InstanceInformationFilter action. The ‘InstanceInformationFilter` action enables you to return instance information by using tags that are specified as a key-value mapping.

If you do use this method, then you can’t use the ‘InstanceInformationFilter` action. Using this method and the `InstanceInformationFilter` action causes an exception error.

Returns:

• (Array<Types::InstanceInformationFilter>)

# File 'lib/aws-sdk-ssm/types.rb', line 4522

class DescribeInstanceInformationRequest < Struct.new(
  :instance_information_filter_list,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Returns:

• (Integer)

# File 'lib/aws-sdk-ssm/types.rb', line 4522

class DescribeInstanceInformationRequest < Struct.new(
  :instance_information_filter_list,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 4522

class DescribeInstanceInformationRequest < Struct.new(
  :instance_information_filter_list,
  :filters,
  :max_results,
  :next_token)
  include Aws::Structure
end