s3init
s3init |
Purpose
Synopsis
procedure s3init(bucket:s3bucket, cfgid:text)
procedure s3init(bucket:s3bucket, cfgid:text, env:text)
Arguments
|
bucket
|
S3 bucket to be configured
|
|
cfgid
|
The ID of the bucket configuration to use.
|
|
env
|
The lifecycle stage of the DMP S3 folder to use; one of the constants
S3_DMP_DESIGN,
S3_DMP_STAGING or
S3_DMP_PRODUCTION. (Xpress Insight only.)
|
Example
Example of initializing an s3bucket to use the DMP
solutionData folder.
declarations
mybucket: s3bucket
end-declarations
s3init(mybucket,S3_DMP_SOLUTIONDATA)
if s3status(mybucket)<>S3_OK then
writeln("Error returned by S3: ",s3getlasterror(mybucket))
exit(1)
end-if
Further information
1. After calling, check the value of
s3status for any errors.
2. If the supplied
s3bucket has already been initialized, the previous configuration will be overwritten.
3. When used from DMP, if
cfgid is
S3_DMP_SOLUTIONDATA and no
env is specified, the lifecycle stage of the component instance running the model will be used.
4. You can only specify a value for
env from within an Xpress Insight component running in DMP.
5. After a s3bucket has been initialized using
s3init, it will not be possible to change the
url or
region field directly.
Related topics