Amazonka.CustomerProfiles.GetWorkflow

Get details of specified workflow.

Creating a Request

data GetWorkflow

See: newGetWorkflow smart constructor.

Constructors

GetWorkflow'

Fields

• domainName :: Text

  The unique name of the domain.

• workflowId :: Text

  Unique identifier for the workflow.

Instances

ToHeaders GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

toHeaders :: GetWorkflow -> [Header]

ToPath GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

toPath :: GetWorkflow -> ByteString

ToQuery GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

toQuery :: GetWorkflow -> QueryString

AWSRequest GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Associated Types

type AWSResponse GetWorkflow

Methods

request :: (Service -> Service) -> GetWorkflow -> Request GetWorkflow

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetWorkflow -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetWorkflow)))

Generic GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Associated Types

type Rep GetWorkflow :: Type -> Type

Methods

from :: GetWorkflow -> Rep GetWorkflow x

to :: Rep GetWorkflow x -> GetWorkflow

Read GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

readsPrec :: Int -> ReadS GetWorkflow

readList :: ReadS [GetWorkflow]

readPrec :: ReadPrec GetWorkflow

readListPrec :: ReadPrec [GetWorkflow]

Show GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

showsPrec :: Int -> GetWorkflow -> ShowS

show :: GetWorkflow -> String

showList :: [GetWorkflow] -> ShowS

NFData GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

rnf :: GetWorkflow -> ()

Eq GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

(==) :: GetWorkflow -> GetWorkflow -> Bool

(/=) :: GetWorkflow -> GetWorkflow -> Bool

Hashable GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

hashWithSalt :: Int -> GetWorkflow -> Int

hash :: GetWorkflow -> Int

type AWSResponse GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

type AWSResponse GetWorkflow = GetWorkflowResponse

type Rep GetWorkflow

Defined in Amazonka.CustomerProfiles.GetWorkflow

type Rep GetWorkflow = D1 ('MetaData "GetWorkflow" "Amazonka.CustomerProfiles.GetWorkflow" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetWorkflow'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetWorkflow

Arguments

:: Text

GetWorkflow

-> Text

GetWorkflow

-> GetWorkflow

Create a value of GetWorkflow with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetWorkflow, getWorkflow_domainName - The unique name of the domain.

GetWorkflow, getWorkflow_workflowId - Unique identifier for the workflow.

Request Lenses

getWorkflow_domainName :: Lens' GetWorkflow Text

The unique name of the domain.

getWorkflow_workflowId :: Lens' GetWorkflow Text

Unique identifier for the workflow.

Destructuring the Response

data GetWorkflowResponse

See: newGetWorkflowResponse smart constructor.

Constructors

GetWorkflowResponse'

Fields

• attributes :: Maybe WorkflowAttributes

  Attributes provided for workflow execution.

• errorDescription :: Maybe Text

  Workflow error messages during execution (if any).

• lastUpdatedAt :: Maybe POSIX

  The timestamp that represents when workflow execution last updated.

• metrics :: Maybe WorkflowMetrics

  Workflow specific execution metrics.

• startDate :: Maybe POSIX

  The timestamp that represents when workflow execution started.

• status :: Maybe Status

  Status of workflow execution.

• workflowId :: Maybe Text

  Unique identifier for the workflow.

• workflowType :: Maybe WorkflowType

  The type of workflow. The only supported value is APPFLOW_INTEGRATION.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetWorkflowResponse

Defined in Amazonka.CustomerProfiles.GetWorkflow

Associated Types

type Rep GetWorkflowResponse :: Type -> Type

Methods

from :: GetWorkflowResponse -> Rep GetWorkflowResponse x

to :: Rep GetWorkflowResponse x -> GetWorkflowResponse

Read GetWorkflowResponse

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

readsPrec :: Int -> ReadS GetWorkflowResponse

readList :: ReadS [GetWorkflowResponse]

readPrec :: ReadPrec GetWorkflowResponse

readListPrec :: ReadPrec [GetWorkflowResponse]

Show GetWorkflowResponse

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

showsPrec :: Int -> GetWorkflowResponse -> ShowS

show :: GetWorkflowResponse -> String

showList :: [GetWorkflowResponse] -> ShowS

NFData GetWorkflowResponse

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

rnf :: GetWorkflowResponse -> ()

Eq GetWorkflowResponse

Defined in Amazonka.CustomerProfiles.GetWorkflow

Methods

(==) :: GetWorkflowResponse -> GetWorkflowResponse -> Bool

(/=) :: GetWorkflowResponse -> GetWorkflowResponse -> Bool

type Rep GetWorkflowResponse

Defined in Amazonka.CustomerProfiles.GetWorkflow

type Rep GetWorkflowResponse = D1 ('MetaData "GetWorkflowResponse" "Amazonka.CustomerProfiles.GetWorkflow" "amazonka-customer-profiles-2.0-7iC4NjyJEW8JuQGNtDiJ1f" 'False) (C1 ('MetaCons "GetWorkflowResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowAttributes)) :*: S1 ('MetaSel ('Just "errorDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastUpdatedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowMetrics)))) :*: ((S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status))) :*: (S1 ('MetaSel ('Just "workflowId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "workflowType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WorkflowType)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetWorkflowResponse

Arguments

:: Int

$sel:httpStatus:GetWorkflowResponse'

-> GetWorkflowResponse

Create a value of GetWorkflowResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetWorkflowResponse, getWorkflowResponse_attributes - Attributes provided for workflow execution.

$sel:errorDescription:GetWorkflowResponse', getWorkflowResponse_errorDescription - Workflow error messages during execution (if any).

GetWorkflowResponse, getWorkflowResponse_lastUpdatedAt - The timestamp that represents when workflow execution last updated.

$sel:metrics:GetWorkflowResponse', getWorkflowResponse_metrics - Workflow specific execution metrics.

$sel:startDate:GetWorkflowResponse', getWorkflowResponse_startDate - The timestamp that represents when workflow execution started.

GetWorkflowResponse, getWorkflowResponse_status - Status of workflow execution.

GetWorkflow, getWorkflowResponse_workflowId - Unique identifier for the workflow.

GetWorkflowResponse, getWorkflowResponse_workflowType - The type of workflow. The only supported value is APPFLOW_INTEGRATION.

$sel:httpStatus:GetWorkflowResponse', getWorkflowResponse_httpStatus - The response's http status code.

Response Lenses

getWorkflowResponse_attributes :: Lens' GetWorkflowResponse (Maybe WorkflowAttributes)

Attributes provided for workflow execution.

getWorkflowResponse_errorDescription :: Lens' GetWorkflowResponse (Maybe Text)

Workflow error messages during execution (if any).

getWorkflowResponse_lastUpdatedAt :: Lens' GetWorkflowResponse (Maybe UTCTime)

The timestamp that represents when workflow execution last updated.

getWorkflowResponse_metrics :: Lens' GetWorkflowResponse (Maybe WorkflowMetrics)

Workflow specific execution metrics.

getWorkflowResponse_startDate :: Lens' GetWorkflowResponse (Maybe UTCTime)

The timestamp that represents when workflow execution started.

getWorkflowResponse_status :: Lens' GetWorkflowResponse (Maybe Status)

Status of workflow execution.

getWorkflowResponse_workflowId :: Lens' GetWorkflowResponse (Maybe Text)

Unique identifier for the workflow.

getWorkflowResponse_workflowType :: Lens' GetWorkflowResponse (Maybe WorkflowType)

The type of workflow. The only supported value is APPFLOW_INTEGRATION.

getWorkflowResponse_httpStatus :: Lens' GetWorkflowResponse Int

The response's http status code.