You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::ListCommandsRequest

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 ListCommandsRequest data as a hash:

{
  command_id: "CommandId",
  instance_id: "InstanceId",
  max_results: 1,
  next_token: "NextToken",
  filters: [
    {
      key: "InvokedAfter", # required, accepts InvokedAfter, InvokedBefore, Status
      value: "CommandFilterValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#command_idString

(Optional) If provided, lists only the specified command.

Returns:

  • (String)


5914
5915
5916
5917
5918
5919
5920
5921
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5914

class ListCommandsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#filtersArray<Types::CommandFilter>

(Optional) One or more filters. Use a filter to return a more specific list of results.

Returns:



5914
5915
5916
5917
5918
5919
5920
5921
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5914

class ListCommandsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#instance_idString

(Optional) Lists commands issued against this instance ID.

Returns:

  • (String)


5914
5915
5916
5917
5918
5919
5920
5921
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5914

class ListCommandsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#max_resultsInteger

(Optional) 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)


5914
5915
5916
5917
5918
5919
5920
5921
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5914

class ListCommandsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


5914
5915
5916
5917
5918
5919
5920
5921
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 5914

class ListCommandsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters)
  include Aws::Structure
end