Class: Aws::Proton::Types::ListServiceInstancesInput

Inherits:

Struct

• Object
• Struct
• Aws::Proton::Types::ListServiceInstancesInput

Defined in:

gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filters ⇒ Array<Types::ListServiceInstancesFilter>

  An array of filtering criteria that scope down the result list.

• #max_results ⇒ Integer

  The maximum number of service instances to list.

• #next_token ⇒ String

  A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

• #service_name ⇒ String

  The name of the service that the service instance belongs to.

• #sort_by ⇒ String

  The field that the result list is sorted by.

• #sort_order ⇒ String

  Result list sort order.

Instance Attribute Details

#filters ⇒ Array<Types::ListServiceInstancesFilter>

An array of filtering criteria that scope down the result list. By default, all service instances in the Amazon Web Services account are returned.

Returns:

• (Array<Types::ListServiceInstancesFilter>)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 4014

class ListServiceInstancesInput < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :service_name,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of service instances to list.

Returns:

• (Integer)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 4014

class ListServiceInstancesInput < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :service_name,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

A token that indicates the location of the next service in the array of service instances, after the list of service instances that was previously requested.

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 4014

class ListServiceInstancesInput < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :service_name,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ String

The name of the service that the service instance belongs to.

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 4014

class ListServiceInstancesInput < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :service_name,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

The field that the result list is sorted by.

When you choose to sort by serviceName, service instances within each service are sorted by service instance name.

Default: serviceName

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 4014

class ListServiceInstancesInput < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :service_name,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

Result list sort order.

Default: ASCENDING

Returns:

• (String)

# File 'gems/aws-sdk-proton/lib/aws-sdk-proton/types.rb', line 4014

class ListServiceInstancesInput < Struct.new(
  :filters,
  :max_results,
  :next_token,
  :service_name,
  :sort_by,
  :sort_order)
  SENSITIVE = []
  include Aws::Structure
end