NAME

Paws::Kendra::CreateFaq - Arguments for method CreateFaq on Paws::Kendra

DESCRIPTION

This class represents the parameters used for calling the method CreateFaq on the AWSKendraFrontendService service. Use the attributes of this class as arguments to method CreateFaq.

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

SYNOPSIS

    my $kendra = Paws->service('Kendra');
    my $CreateFaqResponse = $kendra->CreateFaq(
      IndexId => 'MyIndexId',
      Name    => 'MyFaqName',
      RoleArn => 'MyRoleArn',
      S3Path  => {
        Bucket => 'MyS3BucketName',    # min: 3, max: 63
        Key    => 'MyS3ObjectKey',     # min: 1, max: 1024
      },
      ClientToken => 'MyClientTokenName',    # OPTIONAL
      Description => 'MyDescription',        # OPTIONAL
      FileFormat  => 'CSV',                  # OPTIONAL
      Tags        => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # max: 256
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $Id = $CreateFaqResponse->Id;
    # Returns a L<Paws::Kendra::CreateFaqResponse> 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/kendra/CreateFaq>

ATTRIBUTES

ClientToken => Str

A token that you provide to identify the request to create a FAQ. Multiple calls to the "CreateFaqRequest" operation with the same client token will create only one FAQ.

Description => Str

A description of the FAQ.

FileFormat => Str

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the "S3Path" parameter.

For more information, see Adding questions and answers (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html).

Valid values are: "CSV", "CSV_WITH_HEADER", "JSON"

REQUIRED IndexId => Str

The identifier of the index that contains the FAQ.

REQUIRED Name => Str

The name that should be associated with the FAQ.

REQUIRED RoleArn => Str

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html).

REQUIRED S3Path => Paws::Kendra::S3Path

The S3 location of the FAQ input data.

Tags => ArrayRef[Paws::Kendra::Tag]

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

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>