/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::RedShift::DescribeClusters

NAME

Paws::RedShift::DescribeClusters - Arguments for method DescribeClusters on Paws::RedShift

DESCRIPTION

This class represents the parameters used for calling the method DescribeClusters on the Amazon Redshift service. Use the attributes of this class as arguments to method DescribeClusters.

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

SYNOPSIS

my $redshift = Paws->service('RedShift');
my $ClustersMessage = $redshift->DescribeClusters(
  ClusterIdentifier => 'MyString',    # OPTIONAL
  Marker            => 'MyString',    # OPTIONAL
  MaxRecords        => 1,             # OPTIONAL
  TagKeys           => [
    'MyString', ...                   # max: 2147483647
  ],    # OPTIONAL
  TagValues => [
    'MyString', ...    # max: 2147483647
  ],    # OPTIONAL
);

# Results:
my $Clusters = $ClustersMessage->Clusters;
my $Marker   = $ClustersMessage->Marker;

# Returns a L<Paws::RedShift::ClustersMessage> 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/redshift/DescribeClusters

ATTRIBUTES

ClusterIdentifier => Str

The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

The default is that all clusters defined for an account are returned.

Marker => Str

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

MaxRecords => Int

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

TagKeys => ArrayRef[Str|Undef]

A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

TagValues => ArrayRef[Str|Undef]

A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeClusters in Paws::RedShift

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