NAME

Paws::ECS::ListTaskDefinitionFamilies - Arguments for method ListTaskDefinitionFamilies on Paws::ECS

DESCRIPTION

This class represents the parameters used for calling the method ListTaskDefinitionFamilies on the Amazon EC2 Container Service service. Use the attributes of this class as arguments to method ListTaskDefinitionFamilies.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListTaskDefinitionFamilies.

SYNOPSIS

    my $ecs = Paws->service('ECS');
    # To list your registered task definition families
    # This example lists all of your registered task definition families.
    my $ListTaskDefinitionFamiliesResponse = $ecs->ListTaskDefinitionFamilies();
    # Results:
    my $families = $ListTaskDefinitionFamiliesResponse->families;
    # Returns a L<Paws::ECS::ListTaskDefinitionFamiliesResponse> object.
    # To filter your registered task definition families
    # This example lists the task definition revisions that start with "hpcc".
    my $ListTaskDefinitionFamiliesResponse =
      $ecs->ListTaskDefinitionFamilies( 'FamilyPrefix' => 'hpcc' );
    # Results:
    my $families = $ListTaskDefinitionFamiliesResponse->families;
    # Returns a L<Paws::ECS::ListTaskDefinitionFamiliesResponse> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/ecs/ListTaskDefinitionFamilies>

ATTRIBUTES

FamilyPrefix => Str

The "familyPrefix" is a string that is used to filter the results of "ListTaskDefinitionFamilies". If you specify a "familyPrefix", only task definition family names that begin with the "familyPrefix" string are returned.

MaxResults => Int

The maximum number of task definition family results returned by "ListTaskDefinitionFamilies" in paginated output. When this parameter is used, "ListTaskDefinitions" 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 "ListTaskDefinitionFamilies" request with the returned "nextToken" value. This value can be between 1 and 100. If this parameter is not used, then "ListTaskDefinitionFamilies" returns up to 100 results and a "nextToken" value if applicable.

NextToken => Str

The "nextToken" value returned from a "ListTaskDefinitionFamilies" request indicating that more results are available to fulfill the request and further calls will be needed. If "maxResults" was provided, it is possible the number of results to be fewer than "maxResults".

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.

Status => Str

The task definition family status with which to filter the "ListTaskDefinitionFamilies" results. By default, both "ACTIVE" and "INACTIVE" task definition families are listed. If this parameter is set to "ACTIVE", only task definition families that have an "ACTIVE" task definition revision are returned. If this parameter is set to "INACTIVE", only task definition families that do not have any "ACTIVE" task definition revisions are returned. If you paginate the resulting output, be sure to keep the "status" value constant in each subsequent request.

Valid values are: "ACTIVE", "INACTIVE", "ALL"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>