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

Class: Aws::EC2::Types::DescribeBundleTasksRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass DescribeBundleTasksRequest data as a hash:

{
  bundle_ids: ["String"],
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  dry_run: false,
}

Contains the parameters for DescribeBundleTasks.

Instance Attribute Summary collapse

Instance Attribute Details

#bundle_idsArray<String>

One or more bundle task IDs.

Default: Describes all your bundle tasks.

Returns:

  • (Array<String>)


5637
5638
5639
5640
5641
5642
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5637

class DescribeBundleTasksRequest < Struct.new(
  :bundle_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (Boolean)


5637
5638
5639
5640
5641
5642
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5637

class DescribeBundleTasksRequest < Struct.new(
  :bundle_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end

#filtersArray<Types::Filter>

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

Returns:



5637
5638
5639
5640
5641
5642
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 5637

class DescribeBundleTasksRequest < Struct.new(
  :bundle_ids,
  :filters,
  :dry_run)
  include Aws::Structure
end