Class: Aws::ECS::Types::ListServicesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ListServicesRequest data as a hash:

{
  cluster: "String",
  next_token: "String",
  max_results: 1,
  launch_type: "EC2", # accepts EC2, FARGATE
  scheduling_strategy: "REPLICA", # accepts REPLICA, DAEMON
}

Instance Attribute Summary collapse

Instance Attribute Details

#clusterString

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String)


3585
3586
3587
3588
3589
3590
3591
3592
# File 'lib/aws-sdk-ecs/types.rb', line 3585

class ListServicesRequest < Struct.new(
  :cluster,
  :next_token,
  :max_results,
  :launch_type,
  :scheduling_strategy)
  include Aws::Structure
end

#launch_typeString

The launch type for the services to list.

Returns:

  • (String)


3585
3586
3587
3588
3589
3590
3591
3592
# File 'lib/aws-sdk-ecs/types.rb', line 3585

class ListServicesRequest < Struct.new(
  :cluster,
  :next_token,
  :max_results,
  :launch_type,
  :scheduling_strategy)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of service results returned by ‘ListServices` in paginated output. When this parameter is used, `ListServices` only returns `maxResults` results in a single page along with a `nextToken` response element. The remaining results of the initial request can be seen by sending another `ListServices` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter is not used, then `ListServices` returns up to 10 results and a `nextToken` value if applicable.

Returns:

  • (Integer)


3585
3586
3587
3588
3589
3590
3591
3592
# File 'lib/aws-sdk-ecs/types.rb', line 3585

class ListServicesRequest < Struct.new(
  :cluster,
  :next_token,
  :max_results,
  :launch_type,
  :scheduling_strategy)
  include Aws::Structure
end

#next_tokenString

The ‘nextToken` value returned from a previous paginated `ListServices` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.

<note markdown=“1”> This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

</note>

Returns:

  • (String)


3585
3586
3587
3588
3589
3590
3591
3592
# File 'lib/aws-sdk-ecs/types.rb', line 3585

class ListServicesRequest < Struct.new(
  :cluster,
  :next_token,
  :max_results,
  :launch_type,
  :scheduling_strategy)
  include Aws::Structure
end

#scheduling_strategyString

The scheduling strategy for services to list.

Returns:

  • (String)


3585
3586
3587
3588
3589
3590
3591
3592
# File 'lib/aws-sdk-ecs/types.rb', line 3585

class ListServicesRequest < Struct.new(
  :cluster,
  :next_token,
  :max_results,
  :launch_type,
  :scheduling_strategy)
  include Aws::Structure
end