imagebuilder / Client / get_workflow

get_workflow¶

imagebuilder.Client.get_workflow(**kwargs)¶

Get a workflow resource object.

Request Syntax

response = client.get_workflow(
    workflowBuildVersionArn='string'
)

Parameters:

workflowBuildVersionArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the workflow resource that you want to get.

Return type:

dict

Returns:

Response Syntax

{
    'workflow': {
        'arn': 'string',
        'name': 'string',
        'version': 'string',
        'description': 'string',
        'changeDescription': 'string',
        'type': 'BUILD'|'TEST'|'DISTRIBUTION',
        'state': {
            'status': 'DEPRECATED',
            'reason': 'string'
        },
        'owner': 'string',
        'data': 'string',
        'kmsKeyId': 'string',
        'dateCreated': 'string',
        'tags': {
            'string': 'string'
        },
        'parameters': [
            {
                'name': 'string',
                'type': 'string',
                'defaultValue': [
                    'string',
                ],
                'description': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- workflow (dict) –
  
  The workflow resource specified in the request.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the workflow resource.
  - name (string) –
    
    The name of the workflow resource.
  - version (string) –
    
    The workflow resource version. Workflow resources are immutable. To make a change, you can clone a workflow or create a new version.
  - description (string) –
    
    The description of the workflow.
  - changeDescription (string) –
    
    Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
  - type (string) –
    
    Specifies the image creation stage that the workflow applies to. Image Builder currently supports build and test workflows.
  - state (dict) –
    
    Describes the current status of the workflow and the reason for that status.
    - status (string) –
      
      The current state of the workflow.
    - reason (string) –
      
      Describes how or why the workflow changed state.
  - owner (string) –
    
    The owner of the workflow resource.
  - data (string) –
    
    Contains the YAML document content for the workflow.
  - kmsKeyId (string) –
    
    The KMS key identifier used to encrypt the workflow resource. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.
  - dateCreated (string) –
    
    The timestamp when Image Builder created the workflow resource.
  - tags (dict) –
    
    The tags that apply to the workflow resource
    - (string) –
      - (string) –
  - parameters (list) –
    
    An array of input parameters that that the image workflow uses to control actions or configure settings.
    - (dict) –
      
      Defines a parameter that’s used to provide configuration details for the workflow.
      - name (string) –
        
        The name of this input parameter.
      - type (string) –
        
        The type of input this parameter provides. The currently supported value is “string”.
      - defaultValue (list) –
        
        The default value of this parameter if no input is provided.
        
        (string) –
      - description (string) –
        
        Describes this parameter.

Exceptions

imagebuilder.Client.exceptions.ServiceException
imagebuilder.Client.exceptions.ClientException
imagebuilder.Client.exceptions.ServiceUnavailableException
imagebuilder.Client.exceptions.InvalidRequestException
imagebuilder.Client.exceptions.ForbiddenException
imagebuilder.Client.exceptions.CallRateLimitExceededException