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
show all
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,
}

Instance Attribute Summary collapse

Instance Attribute Details

#arnsArray<String>

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

Returns:

  • (Array<String>)


1556
1557
1558
1559
1560
1561
1562
1563
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1556

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

#max_resultsInteger

The maximum size of each page of results.

Returns:

  • (Integer)


1556
1557
1558
1559
1560
1561
1562
1563
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1556

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

#namesArray<String>

The names of the public or private images to describe.

Returns:

  • (Array<String>)


1556
1557
1558
1559
1560
1561
1562
1563
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1556

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

#next_tokenString

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

  • (String)


1556
1557
1558
1559
1560
1561
1562
1563
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1556

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

#typeString

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

Returns:

  • (String)


1556
1557
1558
1559
1560
1561
1562
1563
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/types.rb', line 1556

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