Remove-S3 Cmdlet
Parameters Output Objects Configuration Settings
The Remove-S3 cmdlet can be used to delete objects and buckets from the Amazon S3 service.
Syntax
Remove-S3 [parameters]
Remarks
The Remove-S3 cmdlet allows you to access Amazon's Simple Storage Service (S3) in a secure manner using SSL. Remove-S3 allows for the deletion of objects and buckets. A brief synopsis follows but please refer to Amazon S3 documentation for details.
You will first need to sign up for the S3 service and obtain an AccessKey and SecretKey from Amazon. Then you can delete buckets or objects in your account using Remove-S3.
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.
#delete objectRemove-S3 -AccessKey $S3AccessKey -SecretKey $S3SecretKey -Bucket TestBucket -RemoteObject test_object#delete bucketRemove-S3 -AccessKey $S3AccessKey -SecretKey $S3SecretKey -Bucket TestBucketParameter List
The following is the full list of the parameters of the cmdlet with short descriptions. Click on the links for further details.
| LogFile | The location of a file to which debug information is written. |
| AccessKey | The Access Key Id for the Amazon Web Services account. |
| Bucket | The name of the S3 bucket. |
| CertPassword | The password to the certificate store. |
| CertStore | The name of the certificate store for the client certificate. |
| CertStoreType | The type of certificate store for the client certificate. |
| CertSubject | The subject of the certificate used for client authentication. |
| Config | Specifies one or more configuration settings. |
| Credential | The PSCredential object to use for authentication. |
| FirewallHost | Name or IP address of firewall. |
| FirewallPassword | A password if authentication is to be used when connecting through the firewall. |
| FirewallPort | The port of the firewall to which to connect. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| Force | Forces the cmdlet to accept the default behavior instead of querying the user. |
| LocalIP | The IP address of the local interface to use. |
| LogFile | The location of a file to which debug information is written. |
| ProxyAutoDetect | Specifies if proxy information is automatically detected. |
| ProxyPassword | The password to authenticate with. |
| ProxyPort | The TCP port of the Proxy . |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | The User value to authenticate with. |
| RemoteObject | Sets the remote object to delete. |
| SecretKey | The Secret Access Key for the Amazon Web Services account. |
| SSL | Use SSL to access Amazon S3. |
| SSLAccept | The encoded public key of the certificate which is to be trusted explicitly. |
| Timeout | The maximum time allowed for the operation. |
| UseVirtualHosting | Determines 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.
| S3Delete | Returned after a Delete operation. |
Configuration Settings
The following is a list of configuration settings for the cmdlet with short descriptions. Click on the links for further details.
| UseBackgroundThread | Whether threads created by the cmdlet are background threads. |
| UseInternalSecurityAPI | Tells the cmdlet whether or not to use the system security libraries or an internal implementation. |