libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTThingsGraph.UpdateFlowTemplate

Description

Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

Synopsis

Creating a Request

data UpdateFlowTemplate Source #

See: newUpdateFlowTemplate smart constructor.

Constructors

UpdateFlowTemplate' 

Fields

  • compatibleNamespaceVersion :: Maybe Integer

    The version of the user's namespace.

    If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

  • id :: Text

    The ID of the workflow to be updated.

    The ID should be in the following format.

    urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
  • definition :: DefinitionDocument

    The DefinitionDocument that contains the updated workflow definition.

Instances

Instances details
Eq UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

(==) :: UpdateFlowTemplate -> UpdateFlowTemplate -> Bool #

(/=) :: UpdateFlowTemplate -> UpdateFlowTemplate -> Bool #

Read UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

readsPrec :: Int -> ReadS UpdateFlowTemplate #

readList :: ReadS [UpdateFlowTemplate] #

readPrec :: ReadPrec UpdateFlowTemplate #

readListPrec :: ReadPrec [UpdateFlowTemplate] #

Show UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

showsPrec :: Int -> UpdateFlowTemplate -> ShowS #

show :: UpdateFlowTemplate -> String #

showList :: [UpdateFlowTemplate] -> ShowS #

Generic UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Associated Types

type Rep UpdateFlowTemplate :: Type -> Type #

Methods

from :: UpdateFlowTemplate -> Rep UpdateFlowTemplate x #

to :: Rep UpdateFlowTemplate x -> UpdateFlowTemplate #

NFData UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

rnf :: UpdateFlowTemplate -> () #

Hashable UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

hashWithSalt :: Int -> UpdateFlowTemplate -> Int #

hash :: UpdateFlowTemplate -> Int #

ToJSON UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

toJSON :: UpdateFlowTemplate -> Value #

toEncoding :: UpdateFlowTemplate -> Encoding #

toJSONList :: [UpdateFlowTemplate] -> Value #

toEncodingList :: [UpdateFlowTemplate] -> Encoding #

AWSRequest UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Associated Types

type AWSResponse UpdateFlowTemplate #

Methods

request :: UpdateFlowTemplate -> Request UpdateFlowTemplate #

response :: MonadResource m => Logger -> Service -> Proxy UpdateFlowTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFlowTemplate))) #

ToHeaders UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

toHeaders :: UpdateFlowTemplate -> [Header] #

ToPath UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

toPath :: UpdateFlowTemplate -> ByteString #

ToQuery UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

toQuery :: UpdateFlowTemplate -> QueryString #

type Rep UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

type Rep UpdateFlowTemplate = D1 ('MetaData "UpdateFlowTemplate" "Amazonka.IoTThingsGraph.UpdateFlowTemplate" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "UpdateFlowTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "compatibleNamespaceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "definition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefinitionDocument))))
type AWSResponse UpdateFlowTemplate Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

type AWSResponse UpdateFlowTemplate = UpdateFlowTemplateResponse

newUpdateFlowTemplate Source #

Arguments

:: Text

$sel:id:UpdateFlowTemplate'

-> DefinitionDocument

$sel:definition:UpdateFlowTemplate'

-> UpdateFlowTemplate 

Create a value of UpdateFlowTemplate 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:

$sel:compatibleNamespaceVersion:UpdateFlowTemplate', updateFlowTemplate_compatibleNamespaceVersion - The version of the user's namespace.

If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

$sel:id:UpdateFlowTemplate', updateFlowTemplate_id - The ID of the workflow to be updated.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

$sel:definition:UpdateFlowTemplate', updateFlowTemplate_definition - The DefinitionDocument that contains the updated workflow definition.

Request Lenses

updateFlowTemplate_compatibleNamespaceVersion :: Lens' UpdateFlowTemplate (Maybe Integer) Source #

The version of the user's namespace.

If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

updateFlowTemplate_id :: Lens' UpdateFlowTemplate Text Source #

The ID of the workflow to be updated.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

updateFlowTemplate_definition :: Lens' UpdateFlowTemplate DefinitionDocument Source #

The DefinitionDocument that contains the updated workflow definition.

Destructuring the Response

data UpdateFlowTemplateResponse Source #

See: newUpdateFlowTemplateResponse smart constructor.

Constructors

UpdateFlowTemplateResponse' 

Fields

Instances

Instances details
Eq UpdateFlowTemplateResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

(==) :: UpdateFlowTemplateResponse -> UpdateFlowTemplateResponse -> Bool #

(/=) :: UpdateFlowTemplateResponse -> UpdateFlowTemplateResponse -> Bool #

Read UpdateFlowTemplateResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

readsPrec :: Int -> ReadS UpdateFlowTemplateResponse #

readList :: ReadS [UpdateFlowTemplateResponse] #

readPrec :: ReadPrec UpdateFlowTemplateResponse #

readListPrec :: ReadPrec [UpdateFlowTemplateResponse] #

Show UpdateFlowTemplateResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

showsPrec :: Int -> UpdateFlowTemplateResponse -> ShowS #

show :: UpdateFlowTemplateResponse -> String #

showList :: [UpdateFlowTemplateResponse] -> ShowS #

Generic UpdateFlowTemplateResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Associated Types

type Rep UpdateFlowTemplateResponse :: Type -> Type #

Methods

from :: UpdateFlowTemplateResponse -> Rep UpdateFlowTemplateResponse x #

to :: Rep UpdateFlowTemplateResponse x -> UpdateFlowTemplateResponse #

NFData UpdateFlowTemplateResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

Methods

rnf :: UpdateFlowTemplateResponse -> () #

type Rep UpdateFlowTemplateResponse Source # 
Instance details

Defined in Amazonka.IoTThingsGraph.UpdateFlowTemplate

type Rep UpdateFlowTemplateResponse = D1 ('MetaData "UpdateFlowTemplateResponse" "Amazonka.IoTThingsGraph.UpdateFlowTemplate" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "UpdateFlowTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlowTemplateSummary)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateFlowTemplateResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateFlowTemplateResponse'

-> UpdateFlowTemplateResponse 

Create a value of UpdateFlowTemplateResponse 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:

$sel:summary:UpdateFlowTemplateResponse', updateFlowTemplateResponse_summary - An object containing summary information about the updated workflow.

$sel:httpStatus:UpdateFlowTemplateResponse', updateFlowTemplateResponse_httpStatus - The response's http status code.

Response Lenses

updateFlowTemplateResponse_summary :: Lens' UpdateFlowTemplateResponse (Maybe FlowTemplateSummary) Source #

An object containing summary information about the updated workflow.

updateFlowTemplateResponse_httpStatus :: Lens' UpdateFlowTemplateResponse Int Source #

The response's http status code.