/AWS1/CL_QQBGETRETRIEVERRSP¶
GetRetrieverResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_applicationid TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID¶
The identifier of the Amazon Q Business application using the retriever.
iv_retrieverid TYPE /AWS1/QQBRETRIEVERID /AWS1/QQBRETRIEVERID¶
The identifier of the retriever.
iv_retrieverarn TYPE /AWS1/QQBRETRIEVERARN /AWS1/QQBRETRIEVERARN¶
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
iv_type TYPE /AWS1/QQBRETRIEVERTYPE /AWS1/QQBRETRIEVERTYPE¶
The type of the retriever.
iv_status TYPE /AWS1/QQBRETRIEVERSTATUS /AWS1/QQBRETRIEVERSTATUS¶
The status of the retriever.
iv_displayname TYPE /AWS1/QQBRETRIEVERNAME /AWS1/QQBRETRIEVERNAME¶
The name of the retriever.
io_configuration TYPE REF TO /AWS1/CL_QQBRETRIEVERCONF /AWS1/CL_QQBRETRIEVERCONF¶
configuration
iv_rolearn TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN¶
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
iv_createdat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP¶
The Unix timestamp when the retriever was created.
iv_updatedat TYPE /AWS1/QQBTIMESTAMP /AWS1/QQBTIMESTAMP¶
The Unix timestamp when the retriever was last updated.
Queryable Attributes¶
applicationId¶
The identifier of the Amazon Q Business application using the retriever.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APPLICATIONID() |
Getter for APPLICATIONID, with configurable default |
ASK_APPLICATIONID() |
Getter for APPLICATIONID w/ exceptions if field has no value |
HAS_APPLICATIONID() |
Determine if APPLICATIONID has a value |
retrieverId¶
The identifier of the retriever.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRIEVERID() |
Getter for RETRIEVERID, with configurable default |
ASK_RETRIEVERID() |
Getter for RETRIEVERID w/ exceptions if field has no value |
HAS_RETRIEVERID() |
Determine if RETRIEVERID has a value |
retrieverArn¶
The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRIEVERARN() |
Getter for RETRIEVERARN, with configurable default |
ASK_RETRIEVERARN() |
Getter for RETRIEVERARN w/ exceptions if field has no value |
HAS_RETRIEVERARN() |
Determine if RETRIEVERARN has a value |
type¶
The type of the retriever.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPE() |
Getter for TYPE, with configurable default |
ASK_TYPE() |
Getter for TYPE w/ exceptions if field has no value |
HAS_TYPE() |
Determine if TYPE has a value |
status¶
The status of the retriever.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
displayName¶
The name of the retriever.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISPLAYNAME() |
Getter for DISPLAYNAME, with configurable default |
ASK_DISPLAYNAME() |
Getter for DISPLAYNAME w/ exceptions if field has no value |
HAS_DISPLAYNAME() |
Determine if DISPLAYNAME has a value |
configuration¶
configuration
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATION() |
Getter for CONFIGURATION |
roleArn¶
The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
createdAt¶
The Unix timestamp when the retriever was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
updatedAt¶
The Unix timestamp when the retriever was last updated.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPDATEDAT() |
Getter for UPDATEDAT, with configurable default |
ASK_UPDATEDAT() |
Getter for UPDATEDAT w/ exceptions if field has no value |
HAS_UPDATEDAT() |
Determine if UPDATEDAT has a value |