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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::ListCommandInvocationsRequest

Includes:

Aws::Structure

Defined in:

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, ExecutionStage, DocumentName
      value: "CommandFilterValue", # required
    },
  ],
  details: false,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #command_id ⇒ String

  (Optional) The invocations for a specific command ID.

• #details ⇒ Boolean

  (Optional) If set this returns the response of the command executions and any command output.

• #filters ⇒ Array<Types::CommandFilter>

  (Optional) One or more filters.

• #instance_id ⇒ String

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

• #max_results ⇒ Integer

  (Optional) The maximum number of items to return for this call.

• #next_token ⇒ String

  (Optional) The token for the next set of items to return.

Instance Attribute Details

#command_id ⇒ String

(Optional) The invocations for a specific command ID.

Returns:

• (String)

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

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

#details ⇒ Boolean

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

Returns:

• (Boolean)

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

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

#filters ⇒ Array<Types::CommandFilter>

(Optional) One or more filters. Use a filter to return a more specific list of results. Note that the ‘DocumentName` filter is not supported for ListCommandInvocations.

Returns:

• (Array<Types::CommandFilter>)

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

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

#instance_id ⇒ String

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

Returns:

• (String)

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

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

#max_results ⇒ Integer

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

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

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

#next_token ⇒ String

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

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