Class: Aws::EC2::Types::DescribeStoreImageTasksRequest

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

{
  image_ids: ["ImageId"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  next_token: "String",
  max_results: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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


23533
23534
23535
23536
23537
23538
23539
23540
23541
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23533

class DescribeStoreImageTasksRequest < Struct.new(
  :image_ids,
  :dry_run,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<Types::Filter>

The filters.

  • task-state - Returns tasks in a certain state (InProgress | Completed | Failed)

  • bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.

Returns:



23533
23534
23535
23536
23537
23538
23539
23540
23541
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23533

class DescribeStoreImageTasksRequest < Struct.new(
  :image_ids,
  :dry_run,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#image_idsArray<String>

The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.

Returns:

  • (Array<String>)


23533
23534
23535
23536
23537
23538
23539
23540
23541
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23533

class DescribeStoreImageTasksRequest < Struct.new(
  :image_ids,
  :dry_run,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200. You cannot specify this parameter and the ImageIDs parameter in the same call.

Returns:

  • (Integer)


23533
23534
23535
23536
23537
23538
23539
23540
23541
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23533

class DescribeStoreImageTasksRequest < Struct.new(
  :image_ids,
  :dry_run,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


23533
23534
23535
23536
23537
23538
23539
23540
23541
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 23533

class DescribeStoreImageTasksRequest < Struct.new(
  :image_ids,
  :dry_run,
  :filters,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end