« blib/lib/Paws/ECS/ListContainerInstancesResponse.pm
↑ Summary
blib/lib/Paws/ECS/ListServicesResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::ListServices; | ||
| 3 | use Moose; | ||
| 4 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 5 | has LaunchType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'launchType' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | has SchedulingStrategy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'schedulingStrategy' ); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListServices'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::ListServicesResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ECS::ListServices - Arguments for method ListServices on L<Paws::ECS> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ListServices on the | ||
| 26 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 27 | as arguments to method ListServices. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListServices. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ecs = Paws->service('ECS'); | ||
| 34 | # To list the services in a cluster | ||
| 35 | # This example lists the services running in the default cluster for an account. | ||
| 36 | my $ListServicesResponse = $ecs->ListServices(); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $serviceArns = $ListServicesResponse->serviceArns; | ||
| 40 | |||
| 41 | # Returns a L<Paws::ECS::ListServicesResponse> object. | ||
| 42 | |||
| 43 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/ListServices> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Cluster => Str | ||
| 50 | |||
| 51 | The short name or full Amazon Resource Name (ARN) of the cluster to use | ||
| 52 | when filtering the C<ListServices> results. If you do not specify a | ||
| 53 | cluster, the default cluster is assumed. | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | =head2 LaunchType => Str | ||
| 58 | |||
| 59 | The launch type to use when filtering the C<ListServices> results. | ||
| 60 | |||
| 61 | Valid values are: C<"EC2">, C<"FARGATE">, C<"EXTERNAL"> | ||
| 62 | |||
| 63 | =head2 MaxResults => Int | ||
| 64 | |||
| 65 | The maximum number of service results returned by C<ListServices> in | ||
| 66 | paginated output. When this parameter is used, C<ListServices> only | ||
| 67 | returns C<maxResults> results in a single page along with a | ||
| 68 | C<nextToken> response element. The remaining results of the initial | ||
| 69 | request can be seen by sending another C<ListServices> request with the | ||
| 70 | returned C<nextToken> value. This value can be between 1 and 100. If | ||
| 71 | this parameter is not used, then C<ListServices> returns up to 10 | ||
| 72 | results and a C<nextToken> value if applicable. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 NextToken => Str | ||
| 77 | |||
| 78 | The C<nextToken> value returned from a C<ListServices> request | ||
| 79 | indicating that more results are available to fulfill the request and | ||
| 80 | further calls will be needed. If C<maxResults> was provided, it is | ||
| 81 | possible the number of results to be fewer than C<maxResults>. | ||
| 82 | |||
| 83 | This token should be treated as an opaque identifier that is only used | ||
| 84 | to retrieve the next items in a list and not for other programmatic | ||
| 85 | purposes. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 SchedulingStrategy => Str | ||
| 90 | |||
| 91 | The scheduling strategy to use when filtering the C<ListServices> | ||
| 92 | results. | ||
| 93 | |||
| 94 | Valid values are: C<"REPLICA">, C<"DAEMON"> | ||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method ListServices in L<Paws::ECS> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |