Amazon Elasticsearch Service
    Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST

      /2015-01-01/packages

      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      POST
      /2015-01-01/packages
      Create a package for use with Amazon ES domains.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/packages' \
--header 'Content-Type: application/json' \
--data-raw '{
    "PackageName": "string",
    "PackageType": "TXT-DICTIONARY",
    "PackageDescription": "string",
    "PackageSource": {
        "S3BucketName": "string",
        "S3Key": "string"
    }
}'
      Response Response Example
      200 - Example 1
      {
  "PackageDetails": {
    "PackageID": "string",
    "PackageName": "string",
    "PackageType": "TXT-DICTIONARY",
    "PackageDescription": "string",
    "PackageStatus": "COPYING",
    "CreatedAt": "string",
    "LastUpdatedAt": "2019-08-24T14:15:22Z",
    "AvailablePackageVersion": "string",
    "ErrorDetails": {
      "ErrorType": "string",
      "ErrorMessage": "string"
    }
  }
}

      Request

      Body Params application/json
      PackageName
      string 
      required
      Unique identifier for the package.
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      PackageType
      enum<string> 
      required
      Type of package. Currently supports only TXT-DICTIONARY.
      Allowed value:
      TXT-DICTIONARY
      PackageDescription
      string 
      optional
      Description of the package.
      <= 1024 characters
      PackageSource
      object 
      required
      The S3 location for importing the package specified as S3BucketName and S3Key
      S3BucketName
      string 
      optional
      Name of the bucket containing the package.
      >= 3 characters<= 63 characters
      S3Key
      string 
      optional
      Key (file name) of the package.
      Examples

      Responses

      🟢200Success
      application/json
      Body
      Container for response returned by <code> <a>CreatePackage</a> </code> operation.
      PackageDetails
      object 
      optional
      Information about the package PackageDetails.
      PackageID
      string 
      optional
      Internal ID of the package.
      PackageName
      string 
      optional
      User specified name of the package.
      >= 3 characters<= 28 characters
      Match pattern:
      [a-z][a-z0-9\-]+
      PackageType
      enum<string> 
      optional
      Currently supports only TXT-DICTIONARY.
      Allowed value:
      TXT-DICTIONARY
      PackageDescription
      string 
      optional
      User-specified description of the package.
      <= 1024 characters
      PackageStatus
      enum<string> 
      optional
      Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
      Allowed values:
      COPYINGCOPY_FAILEDVALIDATINGVALIDATION_FAILEDAVAILABLEDELETINGDELETEDDELETE_FAILED
      CreatedAt
      string <date-time>
      optional
      Timestamp which tells creation date of the package.
      LastUpdatedAt
      string <date-time>
      LastUpdated
      optional
      AvailablePackageVersion
      string 
      PackageVersion
      optional
      ErrorDetails
      object 
      optional
      Additional information if the package is in an error state. Null otherwise.
      🟠480BaseException
      🟠481InternalException
      🟠482LimitExceededException
      🟠483InvalidTypeException
      🟠484ResourceAlreadyExistsException
      🟠485AccessDeniedException
      🟠486ValidationException
      Previous
      /2015-01-01/es/ccs/outboundConnection
      Next
      /2015-01-01/es/vpcEndpoints
      Built with