Amazon CloudSearch
Developer Guide (API Version 2011-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

cs-configure-from-sdf

NAME

cs-configure-from-sdf - Define index fields for a domain based on the 
                        contents of one or more SDF batches.
  
SYNOPSIS

cs-configure-from-sdf --source FILE|S3_URI [--replace] [--force] COMMON_OPTIONS

DESCRIPTION

Scans SDF batches specified with the --source option and configures index
fields for all of the document fields. Prompts for confirmation before 
making any changes unless you specify the --force option.

By default, fields that have already been configured are left as-is.
You can use the --replace option to overwrite the existing configuration.

COMMON OPTIONS

-a, --access-key STRING         Your AWS access key. Used in conjunction
                                with --secret-key. Required if you 
                                do not use an AWS credential file.

-c, --aws-credential-file FILE  The path to the file that contains your AWS
                                credentials. Required if you have not
                                set the AWS_CREDENTIAL_FILE environment
                                variable or explicitly set your credentials
                                with --access-key and --secret-key.
 
-d, --domain-name STRING        The name of the domain that you are
                                configuring. Required.
 
-e,  --endpoint URL             The endpoint for the Amazon CloudSearch
                                Configuration Service. Defaults to the 
                                CS_ENDPOINT environment variable or
                                cloudsearch.us-east-1.amazonaws.com
                                if the environment variable is not set. 
                                Optional.  
 
-h, --help                      Display this help message. Optional.

-k, --secret-key STRING         Your AWS secret key. Used in conjunction with
                                --access-key. Required if you do not
                                use an AWS credential file.
 
-ve, --verbose                  Display verbose log messages. Optional.
 
-v, --version                   Display the version number of the command
                                line tools. Optional.
 
FIELD OPTIONS

-f,  --force                    Apply changes to the domain's configuration
                                without confirmation. Optional.
 
-re, --replace                  Upload configuration information for all
                                identified fields and overwrite the
                                configuration of any fields that were
                                already defined. (Prompts for confirmation
                                unless you also specify --force.) Optional.

-s, --source FILE|S3 URI        The path to a file or an S3 URI that contains
                                the data you want to scan. You can specify
                                 multiple files or S3 URIs. For example: 
                                --source SDF1.json SDF2.json. Required.

EXAMPLES

cs-configure-from-sdf -d mydomain --source s3://mybucket/myAmazingDataSet 
                      COMMON_OPTIONS