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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::InstanceInformationStringFilter>

One or more filters. Use a filter to return a more specific list of instances. You can filter based on tags applied to EC2 instances. Use this Filters data type instead of InstanceInformationFilterList, which is deprecated.



4864
4865
4866
4867
4868
4869
4870
4871
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4864

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

#instance_information_filter_listArray<Types::InstanceInformationFilter>

This is a legacy method. We recommend that you don't use this method. Instead, use the Filters data type. Filters enables you to return instance information by filtering based on tags applied to managed instances.

Attempting to use InstanceInformationFilterList and Filters leads to an exception error.



4864
4865
4866
4867
4868
4869
4870
4871
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4864

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

#max_resultsInteger

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)


4864
4865
4866
4867
4868
4869
4870
4871
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4864

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

#next_tokenString

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

Returns:

  • (String)


4864
4865
4866
4867
4868
4869
4870
4871
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 4864

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