IoTSiteWise / Client / update_pipeline

update_pipeline¶

IoTSiteWise.Client.update_pipeline(**kwargs)¶

Updates an existing pipeline in the specified workspace. Only the fields provided in the request are updated; fields not included in the request are preserved unchanged. You can update the pipeline description, environment variables, and the list of compute nodes independently.

Request Syntax

response = client.update_pipeline(
    workspaceName='string',
    pipelineName='string',
    description='string',
    environmentVariables={
        'string': 'string'
    },
    computations=[
        {
            'computeNodeName': 'string',
            'taskName': 'string',
            'environmentVariables': {
                'string': 'string'
            },
            'dependsOn': [
                'string',
            ]
        },
    ]
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace.
pipelineName (string) –
[REQUIRED]

The name of the pipeline to update.
description (string) – A new description for the pipeline.
environmentVariables (dict) –
Updated environment variables shared across all compute nodes.
- (string) –
  
  Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
  - (string) –
    
    Environment variable value
computations (list) –
Updated list of compute nodes forming the pipeline DAG.
- (dict) –
  
  A single compute node in a pipeline DAG. Each compute node references a task and can declare dependencies on other nodes.
  - computeNodeName (string) – [REQUIRED]
    
    The unique name for this compute node within the pipeline.
  - taskName (string) – [REQUIRED]
    
    The name of the task to execute for this compute node.
  - environmentVariables (dict) –
    
    Environment variables specific to this compute node. These override pipeline-level environment variables with the same key.
    - (string) –
      
      Environment variable name following POSIX naming rules Must not start with AWS_ prefix (case-insensitive)
      - (string) –
        
        Environment variable value
  - dependsOn (list) –
    
    A list of compute node names that must complete successfully before this node can start.
    - (string) –
      
      Reusable resource name with alphanumeric, hyphen, and underscore characters.

Return type:

dict

Returns:

Response Syntax

{
    'version': 'string',
    'status': {
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string'
        },
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED'
    }
}

Response Structure

(dict) –

Response structure for UpdatePipeline operation.
- version (string) –
  
  The new version of the pipeline created by this update.
- status (dict) –
  
  The current lifecycle status of the pipeline.
  - error (dict) –
    
    Contains associated error information, if any.
    - code (string) –
      
      The error code.
    - message (string) –
      
      The error message.
  - state (string) –
    
    The current status of the resource.

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.LimitExceededException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.ConflictingOperationException