Class: Aws::OpenSearchService::Types::GetCapabilityResponse

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

Overview

The result of a GetCapability request. Contains details about the capability.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_id ⇒ String

The unique identifier of the OpenSearch UI application.

Returns:

  • (String)


5017
5018
5019
5020
5021
5022
5023
5024
5025
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5017

class GetCapabilityResponse < Struct.new(
  :capability_name,
  :application_id,
  :status,
  :capability_config,
  :failures)
  SENSITIVE = []
  include Aws::Structure
end

#capability_config ⇒ Types::CapabilityExtendedResponseConfig

The configuration settings for the capability, including capability-specific settings such as AI configuration.



5017
5018
5019
5020
5021
5022
5023
5024
5025
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5017

class GetCapabilityResponse < Struct.new(
  :capability_name,
  :application_id,
  :status,
  :capability_config,
  :failures)
  SENSITIVE = []
  include Aws::Structure
end

#capability_name ⇒ String

The name of the capability.

Returns:

  • (String)


5017
5018
5019
5020
5021
5022
5023
5024
5025
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5017

class GetCapabilityResponse < Struct.new(
  :capability_name,
  :application_id,
  :status,
  :capability_config,
  :failures)
  SENSITIVE = []
  include Aws::Structure
end

#failures ⇒ Array<Types::CapabilityFailure>

A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.

Returns:



5017
5018
5019
5020
5021
5022
5023
5024
5025
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5017

class GetCapabilityResponse < Struct.new(
  :capability_name,
  :application_id,
  :status,
  :capability_config,
  :failures)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the capability. Possible values: creating, create_failed, active, updating, update_failed, deleting, delete_failed.

Returns:

  • (String)


5017
5018
5019
5020
5021
5022
5023
5024
5025
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5017

class GetCapabilityResponse < Struct.new(
  :capability_name,
  :application_id,
  :status,
  :capability_config,
  :failures)
  SENSITIVE = []
  include Aws::Structure
end