Proton / Client / get_service_template

get_service_template#

Proton.Client.get_service_template(**kwargs)#

Get detailed data for a service template.

Request Syntax

response = client.get_service_template(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the service template that you want to get detailed data for.

Return type:

dict

Returns:

Response Syntax

{
    'serviceTemplate': {
        'arn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'displayName': 'string',
        'encryptionKey': 'string',
        'lastModifiedAt': datetime(2015, 1, 1),
        'name': 'string',
        'pipelineProvisioning': 'CUSTOMER_MANAGED',
        'recommendedVersion': 'string'
    }
}

Response Structure

(dict) –
- serviceTemplate (dict) –
  
  The detailed data of the requested service template.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of the service template.
  - createdAt (datetime) –
    
    The time when the service template was created.
  - description (string) –
    
    A description of the service template.
  - displayName (string) –
    
    The service template name as displayed in the developer interface.
  - encryptionKey (string) –
    
    The customer provided service template encryption key that’s used to encrypt data.
  - lastModifiedAt (datetime) –
    
    The time when the service template was last modified.
  - name (string) –
    
    The name of the service template.
  - pipelineProvisioning (string) –
    
    If pipelineProvisioning is true, a service pipeline is included in the service template. Otherwise, a service pipeline isn’t included in the service template.
  - recommendedVersion (string) –
    
    The recommended version of the service template.

Exceptions

Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException