Class: Aws::SSM::Types::CommandPlugin

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Describes plugin details.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the plugin. Must be one of the following: `aws:updateAgent`, `aws:domainjoin`, `aws:applications`, `aws:runPowerShellScript`, `aws:psmodule`, `aws:cloudWatch`, `aws:runShellScript`, or `aws:updateSSMAgent`.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#outputString

Output of the plugin execution.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_bucket_nameString

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

`doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript`

`doc-example-bucket` is the name of the S3 bucket;

`ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix` is the name of the S3 prefix;

`i-02573cafcfEXAMPLE` is the instance ID;

`awsrunShellScript` is the name of the plugin.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_key_prefixString

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

`doc-example-bucket/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-02573cafcfEXAMPLE/awsrunShellScript`

`doc-example-bucket` is the name of the S3 bucket;

`ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix` is the name of the S3 prefix;

`i-02573cafcfEXAMPLE` is the instance ID;

`awsrunShellScript` is the name of the plugin.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#output_s3_regionString

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Amazon Web Services Systems Manager automatically determines the S3 bucket region.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#response_codeInteger

A numeric response code generated after running the plugin.

Returns:

  • (Integer)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#response_finish_date_timeTime

The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.

Returns:

  • (Time)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#response_start_date_timeTime

The time the plugin started running.

Returns:

  • (Time)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#standard_error_urlString

The URL for the complete text written by the plugin to stderr. If execution isn't yet complete, then this string is empty.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#standard_output_urlString

The URL for the complete text written by the plugin to stdout in Amazon S3. If the S3 bucket for the command wasn't specified, then this string is empty.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of this plugin. You can run a document with multiple plugins.

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end

#status_detailsString

A detailed status of the plugin execution. `StatusDetails` includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see [Understanding command statuses] in the *Amazon Web Services Systems Manager User Guide*. StatusDetails can be one of the following values:

  • Pending: The command hasn't been sent to the instance.

  • In Progress: The command has been sent to the instance but hasn't reached a terminal state.

  • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

  • Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's `MaxErrors` limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the `MaxErrors` limit of the parent command. This is a terminal state.

  • Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

  • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html

Returns:

  • (String)

2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/aws-sdk-ssm/types.rb', line 2355

class CommandPlugin < Struct.new(
  :name,
  :status,
  :status_details,
  :response_code,
  :response_start_date_time,
  :response_finish_date_time,
  :output,
  :standard_output_url,
  :standard_error_url,
  :output_s3_region,
  :output_s3_bucket_name,
  :output_s3_key_prefix)
  SENSITIVE = []
  include Aws::Structure
end