Rename-S3 Cmdlet

Parameters   Output Objects   Configuration Settings  

The Rename-S3 cmdlet is used to rename objects on Amazon S3 servers.

Syntax

Rename-S3 [parameters]

Remarks

The appropriate Amazon S3 credentials should be passed to the AccessKey, and SecretKey parameters. The Bucket parameter should be set to the bucket where the object resides. The object to rename is given by RemoteObject and the new name is given by NewName.

The cmdlets support pipeline input for some of their parameters. Prebuilding an object and piping it to the cmdlet is very useful, but should be used with caution to prevent security conflicts. Steps have been taken to decrease the risk of a possibly accidental pipe to the cmdlet, for instance, the Credential parameter cannot be piped to the cmdlet and must be specified manually.


# rename a file
Rename-S3 -AccessKey $s3access -SecretKey $s3secret -Bucket myBucket -RemoteObject oldname.txt -NewName newname.txt

Parameter List


The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.

LogFileThe location of a file to which debug information is written.
AccessKeyThe Access Key Id for the Amazon Web Services account.
BucketThe name of the current bucket.
CertPasswordThe password to the certificate store.
CertStoreThe name of the certificate store for the client certificate.
CertStoreTypeThe type of certificate store for the client certificate.
CertSubjectThe subject of the certificate used for client authentication.
ConfigSpecifies one or more configuration settings.
CredentialThe PSCredential object to use for authentication.
FirewallHostName or IP address of firewall.
FirewallPasswordA password if authentication is to be used when connecting through the firewall.
FirewallPortThe port of the firewall to which to connect.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
ForceForces the cmdlet to accept the default behavior instead of querying the user.
LocalFileThe local file to save the object data to.
LocalIPThe IP address of the local interface to use.
LogFileThe location of a file to which debug information is written.
NewNameRename the file specified by RemoteFile .
ProxyAutoDetectSpecifies if proxy information is automatically detected.
ProxyPasswordThe password to authenticate with.
ProxyPortThe TCP port of the Proxy .
ProxyServerName or IP address of a proxy server (optional).
ProxyUserThe User value to authenticate with.
RegionThe region the cmdlet will make requests against.
RemoteObjectThe name of the remote object to rename.
SecretKeyThe Secret Access Key for the Amazon Web Services account.
SSLUse SSL to access Amazon S3.
SSLAcceptThe encoded public key of the certificate which is to be trusted explicitly.
TimeoutThe maximum time allowed for the operation.
UseVirtualHostingDetermines which style request to use.

Output Objects


The following is the full list of the output objects returned by the cmdlet with short descriptions. Click on the links for further details.

BucketReturned for each bucket during a list bucket operation.

Configuration Settings


The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
NetCmdlets 2020 - Version 20.0 [Build 7877]