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

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::GetCapabilityResponse

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchservice/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The unique identifier of the OpenSearch UI application.

• #capability_config ⇒ Types::CapabilityExtendedResponseConfig

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

• #capability_name ⇒ String

  The name of the capability.

• #failures ⇒ Array<Types::CapabilityFailure>

  A list of failures associated with the capability, if any.

• #status ⇒ String

  The current status of the capability.

Instance Attribute Details

#application_id ⇒ String

The unique identifier of the OpenSearch UI application.

Returns:

• (String)

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

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.

Returns:

• (Types::CapabilityExtendedResponseConfig)

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

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)

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

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:

• (Array<Types::CapabilityFailure>)

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

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)

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

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