(DataFlex) S3 Rename File

See more Amazon S3 (new) Examples

Demonstrates how to rename a file on Amazon S3.

Renaming an object (file) in AWS S3 using the AWS S3 API involves copying the object to a new location with the desired name and then deleting the original object.

For more information, see https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html#API_CopyObject_Examples

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoRest
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    Boolean iSuccess
    Variant vAuthAws
    Handle hoAuthAws
    Variant vSbResponse
    Handle hoSbResponse
    Integer iStatusCode
    String sTemp1
    Integer iTemp1

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // Connect to the Amazon AWS REST server in the desired region.
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "s3-us-west-2.amazonaws.com" iPort iBTls iBAutoReconnect To iSuccess

    // Provide AWS credentials.
    Get Create (RefClass(cComChilkatAuthAws)) To hoAuthAws
    If (Not(IsComObjectCreated(hoAuthAws))) Begin
        Send CreateComObject of hoAuthAws
    End
    Set ComAccessKey Of hoAuthAws To "AWS_ACCESS_KEY"
    Set ComSecretKey Of hoAuthAws To "AWS_SECRET_KEY"
    Set ComServiceName Of hoAuthAws To "s3"

    // This particular bucket is in the Oregon region, as opposed to the US Standard,
    // therefore the Region must be set appropriately.
    // Also note that we connected to "s3-us-west-2.amazonaws.com".
    Set ComRegion Of hoAuthAws To "us-west-2"

    Get pvComObject of hoAuthAws to vAuthAws
    Get ComSetAuthAws Of hoRest vAuthAws To iSuccess

    // Set the bucket name via the HOST header.
    // In this case, the bucket name is "chilkat.qa".
    // Note that the Host header should use "bucketName.s3.amazonaws.com", not "bucketName.s3-us-west-2.amazonaws.com"
    Set ComHost Of hoRest To "chilkat.qa.s3.amazonaws.com"

    // Copy /images/sea_creatures/starfish.jpg to /images/sea_creatures/starfish3.jpg
    // Notice here that the x-amz-copy-source includes the bucket in the source path,
    // but the target path passed to FullRequestNoBody does NOT contain the bucket (because the bucket
    // was already specified in the Host header).
    Get ComAddHeader Of hoRest "x-amz-copy-source" "/chilkat.qa/images/sea_creatures/starfish.jpg" To iSuccess

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponse
    If (Not(IsComObjectCreated(hoSbResponse))) Begin
        Send CreateComObject of hoSbResponse
    End
    Get pvComObject of hoSbResponse to vSbResponse
    Get ComFullRequestNoBodySb Of hoRest "PUT" "/images/sea_creatures/starfish3.jpg" vSbResponse To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // When successful, the S3 Storage service will respond with a 200 or 204 response code,
    // with an XML body.  
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        // Examine the request/response to see what happened.
        Get ComResponseStatusCode Of hoRest To iTemp1
        Showln "response status code = " iTemp1
        Get ComResponseStatusText Of hoRest To sTemp1
        Showln "response status text = " sTemp1
        Get ComResponseHeader Of hoRest To sTemp1
        Showln "response header: " sTemp1
        Get ComGetAsString Of hoSbResponse To sTemp1
        Showln "response body: " sTemp1
        Showln "---"
        Get ComLastRequestStartLine Of hoRest To sTemp1
        Showln "LastRequestStartLine: " sTemp1
        Get ComLastRequestHeader Of hoRest To sTemp1
        Showln "LastRequestHeader: " sTemp1
    End

    Get ComGetAsString Of hoSbResponse To sTemp1
    Showln sTemp1
    Showln "Copy Successful."

    // --------------------------------------
    // Now we can delete the original file..
    // --------------------------------------

    // We no longer want to send the x-amz-copy-source header.  Remove it.
    Get ComRemoveHeader Of hoRest "x-amz-copy-source" To iSuccess

    Get pvComObject of hoSbResponse to vSbResponse
    Get ComFullRequestNoBodySb Of hoRest "DELETE" "/images/sea_creatures/starfish.jpg" vSbResponse To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // If successfully deleted, the response status code is 204 and the response body text will be empty.
    Get ComResponseStatusCode Of hoRest To iStatusCode
    Showln "Response status code = " iStatusCode
    Showln "Response text = "
    Get ComGetAsString Of hoSbResponse To sTemp1
    Showln sTemp1


End_Procedure