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

Class: Aws::AppStream::Types::DescribeImagesRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppStream::Types::DescribeImagesRequest

Defined in:

gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb

Overview

Note:

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

{
  names: ["String"],
  arns: ["Arn"],
  type: "PUBLIC", # accepts PUBLIC, PRIVATE, SHARED
  next_token: "String",
  max_results: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #arns ⇒ Array<String>

  The ARNs of the public, private, and shared images to describe.

• #max_results ⇒ Integer

  The maximum size of each page of results.

• #names ⇒ Array<String>

  The names of the images to describe.

• #next_token ⇒ String

  The pagination token to use to retrieve the next page of results.

• #type ⇒ String

  The type of image (public, private, or shared) to describe.

Instance Attribute Details

#arns ⇒ Array<String>

The ARNs of the public, private, and shared images to describe.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1072

class DescribeImagesRequest < Struct.new(
  :names,
  :arns,
  :type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum size of each page of results.

Returns:

• (Integer)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1072

class DescribeImagesRequest < Struct.new(
  :names,
  :arns,
  :type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#names ⇒ Array<String>

The names of the images to describe.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1072

class DescribeImagesRequest < Struct.new(
  :names,
  :arns,
  :type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_token ⇒ String

The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1072

class DescribeImagesRequest < Struct.new(
  :names,
  :arns,
  :type,
  :next_token,
  :max_results)
  include Aws::Structure
end

#type ⇒ String

The type of image (public, private, or shared) to describe.

Returns:

• (String)

# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1072

class DescribeImagesRequest < Struct.new(
  :names,
  :arns,
  :type,
  :next_token,
  :max_results)
  include Aws::Structure
end