Method: Aws::Proton::Client#get_service_instance

Defined in:

lib/aws-sdk-proton/client.rb

#get_service_instance(params = {}) ⇒ Types::GetServiceInstanceOutput

Get detailed data for a service instance. A service instance is an instantiation of service template and it runs in a specific environment.

The following waiters are defined for this operation (see #wait_until for detailed usage):

* service_instance_deployed

Examples:

Request syntax with placeholder values

resp = client.get_service_instance({
  name: "ResourceName", # required
  service_name: "ResourceName", # required
})

Response structure

resp.service_instance.arn #=> String
resp.service_instance.created_at #=> Time
resp.service_instance.deployment_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETE_COMPLETE", "CANCELLING", "CANCELLED"
resp.service_instance.deployment_status_message #=> String
resp.service_instance.environment_name #=> String
resp.service_instance.last_attempted_deployment_id #=> String
resp.service_instance.last_client_request_token #=> String
resp.service_instance.last_deployment_attempted_at #=> Time
resp.service_instance.last_deployment_succeeded_at #=> Time
resp.service_instance.last_succeeded_deployment_id #=> String
resp.service_instance.name #=> String
resp.service_instance.service_name #=> String
resp.service_instance.spec #=> String
resp.service_instance.template_major_version #=> String
resp.service_instance.template_minor_version #=> String
resp.service_instance.template_name #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :name (required, String) —

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

• :service_name (required, String) —

  The name of the service that you want the service instance input for.

Returns:

• (Types::GetServiceInstanceOutput) —

  Returns a response object which responds to the following methods:

  • #service_instance => Types::ServiceInstance

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-proton/client.rb', line 3176

def get_service_instance(params = {}, options = {})
  req = build_request(:get_service_instance, params)
  req.send_request(options)
end