Class: Aws::OpenSearchService::Types::PackageDetails

Inherits:

Struct

Object
Struct
Aws::OpenSearchService::Types::PackageDetails

show all

Defined in:: gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb

Overview

Basic information about a package.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#allow_listed_user_list ⇒ Array<String>
A list of users who are allowed to view and associate the package.
#available_package_configuration ⇒ Types::PackageConfiguration
This represents the available configuration parameters for the package.
#available_package_version ⇒ String
The package version.
#available_plugin_properties ⇒ Types::PluginProperties
If the package is a ZIP-PLUGIN package, additional information about plugin properties.
#created_at ⇒ Time
The timestamp when the package was created.
#engine_version ⇒ String
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
#error_details ⇒ Types::ErrorDetails
Additional information if the package is in an error state.
#last_updated_at ⇒ Time
Date and time when the package was last updated.
#package_description ⇒ String
User-specified description of the package.
#package_encryption_options ⇒ Types::PackageEncryptionOptions
Encryption options for a package.
#package_id ⇒ String
The unique identifier of the package.
#package_name ⇒ String
The user-specified name of the package.
#package_owner ⇒ String
The owner of the package who is allowed to create and update a package and add users to the package scope.
#package_status ⇒ String
The current status of the package.
#package_type ⇒ String
The type of package.
#package_vending_options ⇒ Types::PackageVendingOptions
Package Vending Options for a package.

Instance Attribute Details

#allow_listed_user_list ⇒ `Array<String>`

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

Returns:

(Array<String>)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#available_package_configuration ⇒ `Types::PackageConfiguration`

This represents the available configuration parameters for the package.

Returns:

(Types::PackageConfiguration)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#available_package_version ⇒ `String`

The package version.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#available_plugin_properties ⇒ `Types::PluginProperties`

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

Returns:

(Types::PluginProperties)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The timestamp when the package was created.

Returns:

(Time)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ `String`

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#error_details ⇒ `Types::ErrorDetails`

Additional information if the package is in an error state. Null otherwise.

Returns:

(Types::ErrorDetails)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ `Time`

Date and time when the package was last updated.

Returns:

(Time)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_description ⇒ `String`

User-specified description of the package.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_encryption_options ⇒ `Types::PackageEncryptionOptions`

Encryption options for a package.

Returns:

(Types::PackageEncryptionOptions)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_id ⇒ `String`

The unique identifier of the package.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_name ⇒ `String`

The user-specified name of the package.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_owner ⇒ `String`

The owner of the package who is allowed to create and update a package and add users to the package scope.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_status ⇒ `String`

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_type ⇒ `String`

The type of package.

Returns:

(String)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

#package_vending_options ⇒ `Types::PackageVendingOptions`

Package Vending Options for a package.

Returns:

(Types::PackageVendingOptions)

# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 6392

class PackageDetails < Struct.new(
  :package_id,
  :package_name,
  :package_type,
  :package_description,
  :package_status,
  :created_at,
  :last_updated_at,
  :available_package_version,
  :error_details,
  :engine_version,
  :available_plugin_properties,
  :available_package_configuration,
  :allow_listed_user_list,
  :package_owner,
  :package_vending_options,
  :package_encryption_options)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::OpenSearchService::Types::PackageDetails

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#allow_listed_user_list ⇒ Array<String>

#available_package_configuration ⇒ Types::PackageConfiguration

#available_package_version ⇒ String

#available_plugin_properties ⇒ Types::PluginProperties

#created_at ⇒ Time

#engine_version ⇒ String

#error_details ⇒ Types::ErrorDetails

#last_updated_at ⇒ Time

#package_description ⇒ String

#package_encryption_options ⇒ Types::PackageEncryptionOptions

#package_id ⇒ String

#package_name ⇒ String

#package_owner ⇒ String

#package_status ⇒ String

#package_type ⇒ String

#package_vending_options ⇒ Types::PackageVendingOptions

#allow_listed_user_list ⇒ `Array<String>`

#available_package_configuration ⇒ `Types::PackageConfiguration`

#available_package_version ⇒ `String`

#available_plugin_properties ⇒ `Types::PluginProperties`

#created_at ⇒ `Time`

#engine_version ⇒ `String`

#error_details ⇒ `Types::ErrorDetails`

#last_updated_at ⇒ `Time`

#package_description ⇒ `String`

#package_encryption_options ⇒ `Types::PackageEncryptionOptions`

#package_id ⇒ `String`

#package_name ⇒ `String`

#package_owner ⇒ `String`

#package_status ⇒ `String`

#package_type ⇒ `String`

#package_vending_options ⇒ `Types::PackageVendingOptions`