Proton / Client / get_service_instance
get_service_instance#
- Proton.Client.get_service_instance(**kwargs)#
Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.
See also: AWS API Documentation
Request Syntax
response = client.get_service_instance( name='string', serviceName='string' )
- Parameters:
name (string) –
[REQUIRED]
The name of a service instance that you want to get the detailed data for.
serviceName (string) –
[REQUIRED]
The name of the service that the service instance belongs to.
- Return type:
dict
- Returns:
Response Syntax
{ 'serviceInstance': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'deploymentStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'CANCELLING'|'CANCELLED', 'deploymentStatusMessage': 'string', 'environmentName': 'string', 'lastDeploymentAttemptedAt': datetime(2015, 1, 1), 'lastDeploymentSucceededAt': datetime(2015, 1, 1), 'name': 'string', 'serviceName': 'string', 'spec': 'string', 'templateMajorVersion': 'string', 'templateMinorVersion': 'string', 'templateName': 'string' } }
Response Structure
(dict) –
serviceInstance (dict) –
The detailed data of the requested service instance.
arn (string) –
The Amazon Resource Name (ARN) of the service instance.
createdAt (datetime) –
The time when the service instance was created.
deploymentStatus (string) –
The service instance deployment status.
deploymentStatusMessage (string) –
The message associated with the service instance deployment status.
environmentName (string) –
The name of the environment that the service instance was deployed into.
lastDeploymentAttemptedAt (datetime) –
The time when a deployment of the service instance was last attempted.
lastDeploymentSucceededAt (datetime) –
The time when the service instance was last deployed successfully.
name (string) –
The name of the service instance.
serviceName (string) –
The name of the service that the service instance belongs to.
spec (string) –
The service spec that was used to create the service instance.
templateMajorVersion (string) –
The major version of the service template that was used to create the service instance.
templateMinorVersion (string) –
The minor version of the service template that was used to create the service instance.
templateName (string) –
The name of the service template that was used to create the service instance.
Exceptions
Proton.Client.exceptions.ValidationException
Proton.Client.exceptions.AccessDeniedException
Proton.Client.exceptions.ThrottlingException
Proton.Client.exceptions.ResourceNotFoundException
Proton.Client.exceptions.InternalServerException