NAME

Paws::CloudSearch::DescribeIndexFields - Arguments for method DescribeIndexFields on Paws::CloudSearch

DESCRIPTION

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

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

SYNOPSIS

    my $cloudsearch = Paws->service('CloudSearch');
    my $DescribeIndexFieldsResponse = $cloudsearch->DescribeIndexFields(
      DomainName => 'MyDomainName',
      Deployed   => 1,                # OPTIONAL
      FieldNames => [
        'MyDynamicFieldName', ...     # min: 1, max: 64
      ],                              # OPTIONAL
    );

    # Results:
    my $IndexFields = $DescribeIndexFieldsResponse->IndexFields;

    # Returns a L<Paws::CloudSearch::DescribeIndexFieldsResponse> 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/cloudsearch/DescribeIndexFields

ATTRIBUTES

Deployed => Bool

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

REQUIRED DomainName => Str

The name of the domain you want to describe.

FieldNames => ArrayRef[Str|Undef]

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

SEE ALSO

This class forms part of Paws, documenting arguments for method DescribeIndexFields in Paws::CloudSearch

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