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

Class: Aws::SSM::Types::ListCommandInvocationsRequest

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 ListCommandInvocationsRequest 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
    },
  ],
  details: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#command_idString

(Optional) The invocations for a specific command ID.

Returns:

  • (String)


6430
6431
6432
6433
6434
6435
6436
6437
6438
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6430

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

#detailsBoolean

(Optional) If set this returns the response of the command executions and any command output. By default this is set to False.

Returns:

  • (Boolean)


6430
6431
6432
6433
6434
6435
6436
6437
6438
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6430

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

#filtersArray<Types::CommandFilter>

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

Returns:



6430
6431
6432
6433
6434
6435
6436
6437
6438
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6430

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

#instance_idString

(Optional) The command execution details for a specific instance ID.

Returns:

  • (String)


6430
6431
6432
6433
6434
6435
6436
6437
6438
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6430

class ListCommandInvocationsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters,
  :details)
  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)


6430
6431
6432
6433
6434
6435
6436
6437
6438
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6430

class ListCommandInvocationsRequest < Struct.new(
  :command_id,
  :instance_id,
  :max_results,
  :next_token,
  :filters,
  :details)
  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)


6430
6431
6432
6433
6434
6435
6436
6437
6438
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 6430

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