/AWS1/CL_BDAGETFLOWRESPONSE

GetFlowResponse

CONSTRUCTOR

IMPORTING

Required arguments:

iv_name TYPE /AWS1/BDAFLOWNAME /AWS1/BDAFLOWNAME

The name of the flow.

iv_executionrolearn TYPE /AWS1/BDAFLOWEXECUTIONROLEARN /AWS1/BDAFLOWEXECUTIONROLEARN

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

iv_id TYPE /AWS1/BDAFLOWID /AWS1/BDAFLOWID

The unique identifier of the flow.

iv_arn TYPE /AWS1/BDAFLOWARN /AWS1/BDAFLOWARN

The Amazon Resource Name (ARN) of the flow.

iv_status TYPE /AWS1/BDAFLOWSTATUS /AWS1/BDAFLOWSTATUS

The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

iv_createdat TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP

The time at which the flow was created.

iv_updatedat TYPE /AWS1/BDADATETIMESTAMP /AWS1/BDADATETIMESTAMP

The time at which the flow was last updated.

iv_version TYPE /AWS1/BDADRAFTVERSION /AWS1/BDADRAFTVERSION

The version of the flow for which information was retrieved.

Optional arguments:

iv_description TYPE /AWS1/BDAFLOWDESCRIPTION /AWS1/BDAFLOWDESCRIPTION

The description of the flow.

iv_customerencryptionkeyarn TYPE /AWS1/BDAKMSKEYARN /AWS1/BDAKMSKEYARN

The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

io_definition TYPE REF TO /AWS1/CL_BDAFLOWDEFINITION /AWS1/CL_BDAFLOWDEFINITION

The definition of the nodes and connections between the nodes in the flow.

it_validations TYPE /AWS1/CL_BDAFLOWVALIDATION=>TT_FLOWVALIDATIONS TT_FLOWVALIDATIONS

A list of validation error messages related to the last failed operation on the flow.

---

Queryable Attributes

name

The name of the flow.

Accessible with the following methods

Method	Description
GET_NAME()	Getter for NAME, with configurable default
ASK_NAME()	Getter for NAME w/ exceptions if field has no value
HAS_NAME()	Determine if NAME has a value

description

The description of the flow.

Accessible with the following methods

Method	Description
GET_DESCRIPTION()	Getter for DESCRIPTION, with configurable default
ASK_DESCRIPTION()	Getter for DESCRIPTION w/ exceptions if field has no value
HAS_DESCRIPTION()	Determine if DESCRIPTION has a value

executionRoleArn

The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

Accessible with the following methods

Method	Description
GET_EXECUTIONROLEARN()	Getter for EXECUTIONROLEARN, with configurable default
ASK_EXECUTIONROLEARN()	Getter for EXECUTIONROLEARN w/ exceptions if field has no va
HAS_EXECUTIONROLEARN()	Determine if EXECUTIONROLEARN has a value

customerEncryptionKeyArn

The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

Accessible with the following methods

Method	Description
GET_CUSTOMERENCRYPTIONKEYARN()	Getter for CUSTOMERENCRYPTIONKEYARN, with configurable defau
ASK_CUSTOMERENCRYPTIONKEYARN()	Getter for CUSTOMERENCRYPTIONKEYARN w/ exceptions if field h
HAS_CUSTOMERENCRYPTIONKEYARN()	Determine if CUSTOMERENCRYPTIONKEYARN has a value

id

The unique identifier of the flow.

Accessible with the following methods

Method	Description
GET_ID()	Getter for ID, with configurable default
ASK_ID()	Getter for ID w/ exceptions if field has no value
HAS_ID()	Determine if ID has a value

arn

The Amazon Resource Name (ARN) of the flow.

Accessible with the following methods

Method	Description
GET_ARN()	Getter for ARN, with configurable default
ASK_ARN()	Getter for ARN w/ exceptions if field has no value
HAS_ARN()	Determine if ARN has a value

status

The status of the flow. The following statuses are possible:

• NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

• Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

• Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

• Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

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

createdAt

The time at which the flow 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 time at which the flow 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

version

The version of the flow for which information was retrieved.

Accessible with the following methods

Method	Description
GET_VERSION()	Getter for VERSION, with configurable default
ASK_VERSION()	Getter for VERSION w/ exceptions if field has no value
HAS_VERSION()	Determine if VERSION has a value

definition

The definition of the nodes and connections between the nodes in the flow.

Accessible with the following methods

Method	Description
GET_DEFINITION()	Getter for DEFINITION

validations

A list of validation error messages related to the last failed operation on the flow.

Accessible with the following methods

Method	Description
GET_VALIDATIONS()	Getter for VALIDATIONS, with configurable default
ASK_VALIDATIONS()	Getter for VALIDATIONS w/ exceptions if field has no value
HAS_VALIDATIONS()	Determine if VALIDATIONS has a value